Waldur API Documentation
| Description | API reference and SDK documentation for Waldur cloud management platform. See the latest version at https://docs.waldur.com |
| Copyright | Copyright © 2016 - 2025 Waldur team |
Table of Contents
API Reference
This section provides a detailed reference for all available API endpoints.
Core
- Automation
- Identity management & access policy
- Invitations & permissions
- Notifications & Logging
- Structure
- System configuration
Marketplace
- Accounts
- Arrow
- Automation
- Booking
- Categories
- Checklists
- Integration
- Maintenance
- Offerings
- Onboarding
- Policies
- Promotions
- Provider API
- Resources & Orders
- Site Agent
- Software Management
- Usage & stats
Billing & Finance
Proposals & Calls
Cloud & HPC Providers
Support & Operations
Billing and finance
Invoices and payments
Customer Credits
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/customer-credits/ |
List Customer Credits |
| GET | /api/customer-credits/{uuid}/ |
Retrieve |
| POST | /api/customer-credits/ |
Create |
| PUT | /api/customer-credits/{uuid}/ |
Update |
| PATCH | /api/customer-credits/{uuid}/ |
Partial Update |
| DELETE | /api/customer-credits/{uuid}/ |
Delete |
| Other Actions | ||
| GET | /api/customer-credits/{uuid}/consumptions/ |
Get credit consumption history grouped by month |
| POST | /api/customer-credits/{uuid}/apply_compensations/ |
Apply compensations |
| POST | /api/customer-credits/{uuid}/clear_compensations/ |
Clear compensations |
Core CRUD
List Customer Credits
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 | |
- Model Source:
CustomerCreditOEnum - API Source:
customer_credits_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
customer_name |
string | |
customer_slug |
string | |
customer_uuid |
string (uuid) | |
o |
array | Ordering |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
query |
string |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
uuid |
string (uuid) |
url |
string (uri) |
value |
string (decimal) |
customer |
string (uri) |
customer_name |
string |
customer_uuid |
string (uuid) |
customer_slug |
string |
offerings |
array of objects |
offerings.uuid |
string (uuid) |
offerings.url |
string (uri) |
offerings.type |
string |
offerings.name |
string |
end_date |
string (date) |
expected_consumption |
string (decimal) |
minimal_consumption |
number (double) |
minimal_consumption_logic |
string |
grace_coefficient |
string (decimal) |
apply_as_minimal_consumption |
boolean |
allocated_to_projects |
number (double) |
consumption_last_month |
number (double) |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
customer_credits_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
url |
string (uri) |
value |
string (decimal) |
customer |
string (uri) |
customer_name |
string |
customer_uuid |
string (uuid) |
customer_slug |
string |
offerings |
array of objects |
offerings.uuid |
string (uuid) |
offerings.url |
string (uri) |
offerings.type |
string |
offerings.name |
string |
end_date |
string (date) |
expected_consumption |
string (decimal) |
minimal_consumption |
number (double) |
minimal_consumption_logic |
string |
grace_coefficient |
string (decimal) |
apply_as_minimal_consumption |
boolean |
allocated_to_projects |
number (double) |
consumption_last_month |
number (double) |
Create
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
- Model Source:
CreateCustomerCreditRequest - API Source:
customer_credits_create
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Field | Type | Required |
|---|---|---|
value |
string (decimal) | |
customer |
string (uri) | ✓ |
offerings |
array of string (uri)s | |
end_date |
string (date) | |
expected_consumption |
string (decimal) | |
minimal_consumption_logic |
string | |
grace_coefficient |
string (decimal) | |
apply_as_minimal_consumption |
boolean |
201 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
url |
string (uri) |
value |
string (decimal) |
customer |
string (uri) |
customer_name |
string |
customer_uuid |
string (uuid) |
customer_slug |
string |
offerings |
array of string (uri)s |
end_date |
string (date) |
expected_consumption |
string (decimal) |
minimal_consumption |
number (double) |
minimal_consumption_logic |
string |
grace_coefficient |
string (decimal) |
apply_as_minimal_consumption |
boolean |
allocated_to_projects |
number (double) |
consumption_last_month |
number (double) |
Update
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
CreateCustomerCreditRequest - API Source:
customer_credits_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
value |
string (decimal) | |
customer |
string (uri) | ✓ |
offerings |
array of string (uri)s | |
end_date |
string (date) | |
expected_consumption |
string (decimal) | |
minimal_consumption_logic |
string | |
grace_coefficient |
string (decimal) | |
apply_as_minimal_consumption |
boolean |
200 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
url |
string (uri) |
value |
string (decimal) |
customer |
string (uri) |
customer_name |
string |
customer_uuid |
string (uuid) |
customer_slug |
string |
offerings |
array of string (uri)s |
end_date |
string (date) |
expected_consumption |
string (decimal) |
minimal_consumption |
number (double) |
minimal_consumption_logic |
string |
grace_coefficient |
string (decimal) |
apply_as_minimal_consumption |
boolean |
allocated_to_projects |
number (double) |
consumption_last_month |
number (double) |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedCreateCustomerCreditRequest - API Source:
customer_credits_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
value |
string (decimal) | |
customer |
string (uri) | |
offerings |
array of string (uri)s | |
end_date |
string (date) | |
expected_consumption |
string (decimal) | |
minimal_consumption_logic |
string | |
grace_coefficient |
string (decimal) | |
apply_as_minimal_consumption |
boolean |
200 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
url |
string (uri) |
value |
string (decimal) |
customer |
string (uri) |
customer_name |
string |
customer_uuid |
string (uuid) |
customer_slug |
string |
offerings |
array of string (uri)s |
end_date |
string (date) |
expected_consumption |
string (decimal) |
minimal_consumption |
number (double) |
minimal_consumption_logic |
string |
grace_coefficient |
string (decimal) |
apply_as_minimal_consumption |
boolean |
allocated_to_projects |
number (double) |
consumption_last_month |
number (double) |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
customer_credits_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
Get credit consumption history grouped by month
Get credit consumption history grouped by month.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
- Model Source:
CustomerCreditOEnum - API Source:
customer_credits_consumptions_list
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
customer_name |
string | |
customer_slug |
string | |
customer_uuid |
string (uuid) | |
o |
array | Ordering |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
query |
string |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
date |
string (date) |
price |
string (decimal) |
Apply compensations
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
CustomerCreditRequest - API Source:
customer_credits_apply_compensations
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
value |
string (decimal) | |
customer |
string (uri) | ✓ |
end_date |
string (date) | |
expected_consumption |
string (decimal) | |
minimal_consumption_logic |
string | |
grace_coefficient |
string (decimal) | |
apply_as_minimal_consumption |
boolean |
200 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
url |
string (uri) |
value |
string (decimal) |
customer |
string (uri) |
customer_name |
string |
customer_uuid |
string (uuid) |
customer_slug |
string |
offerings |
array of objects |
offerings.uuid |
string (uuid) |
offerings.url |
string (uri) |
offerings.type |
string |
offerings.name |
string |
end_date |
string (date) |
expected_consumption |
string (decimal) |
minimal_consumption |
number (double) |
minimal_consumption_logic |
string |
grace_coefficient |
string (decimal) |
apply_as_minimal_consumption |
boolean |
allocated_to_projects |
number (double) |
consumption_last_month |
number (double) |
Clear compensations
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
CustomerCreditRequest - API Source:
customer_credits_clear_compensations
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
value |
string (decimal) | |
customer |
string (uri) | ✓ |
end_date |
string (date) | |
expected_consumption |
string (decimal) | |
minimal_consumption_logic |
string | |
grace_coefficient |
string (decimal) | |
apply_as_minimal_consumption |
boolean |
200 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
url |
string (uri) |
value |
string (decimal) |
customer |
string (uri) |
customer_name |
string |
customer_uuid |
string (uuid) |
customer_slug |
string |
offerings |
array of objects |
offerings.uuid |
string (uuid) |
offerings.url |
string (uri) |
offerings.type |
string |
offerings.name |
string |
end_date |
string (date) |
expected_consumption |
string (decimal) |
minimal_consumption |
number (double) |
minimal_consumption_logic |
string |
grace_coefficient |
string (decimal) |
apply_as_minimal_consumption |
boolean |
allocated_to_projects |
number (double) |
consumption_last_month |
number (double) |
Invoice Items
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/invoice-items/ |
List Invoice Items |
| GET | /api/invoice-items/{uuid}/ |
Retrieve |
| POST | /api/invoice-items/{uuid}/create_compensation/ |
Create compensation invoice item for selected invoice item |
| PUT | /api/invoice-items/{uuid}/ |
Update |
| PATCH | /api/invoice-items/{uuid}/ |
Partial Update |
| DELETE | /api/invoice-items/{uuid}/ |
Delete |
| Other Actions | ||
| GET | /api/invoice-items/{uuid}/consumptions/ |
Consumptions |
| GET | /api/invoice-items/costs/ |
Get costs breakdown for a project by year and month |
| GET | /api/invoice-items/customer_costs_for_period/ |
Customer costs for period |
| GET | /api/invoice-items/project_costs_for_period/ |
Get resource cost breakdown for a project over a specified period |
| GET | /api/invoice-items/total_price/ |
Calculate total price for filtered invoice items |
| POST | /api/invoice-items/{uuid}/migrate_to/ |
Move invoice item from one invoice to another one |
Core CRUD
List Invoice Items
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
invoice_items_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
credit_uuid |
string (uuid) | |
customer_uuid |
string (uuid) | |
month |
integer | |
offering_uuid |
string (uuid) | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
project_uuid |
string (uuid) | |
resource_uuid |
string (uuid) | |
start_month |
number | Start month |
start_year |
number | Start year |
year |
integer |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
invoice |
string (uri) | |
resource |
string (uri) | |
uuid |
string (uuid) | |
article_code |
string | |
unit_price |
string (decimal) | |
unit |
string | Enum: month, quarter, half_month, day, hour, quantity |
quantity |
string (decimal) | |
measured_unit |
string | Unit of measurement, for example, GB. |
name |
string | |
start |
string (date-time) | Date and time when item usage has started. |
end |
string (date-time) | Date and time when item usage has ended. |
price |
number (double) | |
details |
any | Stores data about scope |
offering_uuid |
string (uuid) | |
offering_name |
string | |
offering_component_type |
string | |
project_uuid |
string (uuid) | |
project_name |
string | |
customer_uuid |
string (uuid) | |
customer_name |
string |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
invoice_items_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
invoice |
string (uri) | |
resource |
string (uri) | |
uuid |
string (uuid) | |
article_code |
string | |
unit_price |
string (decimal) | |
unit |
string | Enum: month, quarter, half_month, day, hour, quantity |
quantity |
string (decimal) | |
measured_unit |
string | Unit of measurement, for example, GB. |
name |
string | |
start |
string (date-time) | Date and time when item usage has started. |
end |
string (date-time) | Date and time when item usage has ended. |
price |
number (double) | |
details |
any | Stores data about scope |
offering_uuid |
string (uuid) | |
offering_name |
string | |
offering_component_type |
string | |
project_uuid |
string (uuid) | |
project_name |
string | |
customer_uuid |
string (uuid) | |
customer_name |
string |
Create compensation invoice item for selected invoice item
Create compensation invoice item for selected invoice item.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
InvoiceItemCompensationRequest - API Source:
invoice_items_create_compensation
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
offering_component_name |
string | ✓ | Name of the offering component for compensation |
200 -
| Field | Type | Description |
|---|---|---|
offering_component_name |
string | Name of the offering component for compensation |
Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
InvoiceItemUpdateRequest - API Source:
invoice_items_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
article_code |
string | ||
quantity |
string (decimal) | ||
unit_price |
string (decimal) | ||
start |
string (date-time) | Date and time when item usage has started. | |
end |
string (date-time) | Date and time when item usage has ended. |
200 -
| Field | Type | Description |
|---|---|---|
article_code |
string | |
quantity |
string (decimal) | |
unit_price |
string (decimal) | |
start |
string (date-time) | Date and time when item usage has started. |
end |
string (date-time) | Date and time when item usage has ended. |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedInvoiceItemUpdateRequest - API Source:
invoice_items_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
article_code |
string | ||
quantity |
string (decimal) | ||
unit_price |
string (decimal) | ||
start |
string (date-time) | Date and time when item usage has started. | |
end |
string (date-time) | Date and time when item usage has ended. |
200 -
| Field | Type | Description |
|---|---|---|
article_code |
string | |
quantity |
string (decimal) | |
unit_price |
string (decimal) | |
start |
string (date-time) | Date and time when item usage has started. |
end |
string (date-time) | Date and time when item usage has ended. |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
invoice_items_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
Consumptions
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
invoice_items_consumptions_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
invoice |
string (uri) | |
resource |
string (uri) | |
uuid |
string (uuid) | |
article_code |
string | |
unit_price |
string (decimal) | |
unit |
string | Enum: month, quarter, half_month, day, hour, quantity |
quantity |
string (decimal) | |
measured_unit |
string | Unit of measurement, for example, GB. |
name |
string | |
start |
string (date-time) | Date and time when item usage has started. |
end |
string (date-time) | Date and time when item usage has ended. |
price |
number (double) | |
details |
any | Stores data about scope |
offering_uuid |
string (uuid) | |
offering_name |
string | |
offering_component_type |
string | |
project_uuid |
string (uuid) | |
project_name |
string | |
customer_uuid |
string (uuid) | |
customer_name |
string |
Get costs breakdown for a project by year and month
Get costs breakdown for a project by year and month.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
invoice_items_costs_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
project_uuid |
string (uuid) | UUID of the project for which statistics should be calculated. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
price |
number (double) |
year |
integer |
month |
integer |
items |
array of objects |
items.name |
string |
items.unit_price |
string (decimal) |
items.unit |
string |
items.quantity |
string (decimal) |
items.measured_unit |
string |
items.price |
number (double) |
Customer costs for period
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
- API Source:
invoice_items_customer_costs_for_period_retrieve
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
customer_uuid |
string (uuid) | UUID of the project for which statistics should be calculated. |
period |
integer | Period for which statistics should be calculated. |
200 -
| Field | Type |
|---|---|
total_price |
string |
start_date |
string (date) |
end_date |
string (date) |
Get resource cost breakdown for a project over a specified period
Get resource cost breakdown for a project over a specified period.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
- API Source:
invoice_items_project_costs_for_period_retrieve
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
period |
integer | Period for which statistics should be calculated (1, 3 or 12 months). |
project_uuid |
string (uuid) | UUID of the project for which statistics should be calculated. |
200 -
| Field | Type |
|---|---|
total_price |
string |
start_date |
string (date) |
end_date |
string (date) |
Calculate total price for filtered invoice items
Calculate total price for filtered invoice items.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
- API Source:
invoice_items_total_price_retrieve
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
credit_uuid |
string (uuid) | |
customer_uuid |
string (uuid) | |
month |
integer | |
offering_uuid |
string (uuid) | |
project_uuid |
string (uuid) | |
resource_uuid |
string (uuid) | |
start_month |
number | Start month |
start_year |
number | Start year |
year |
integer |
200 -
| Field | Type | Description |
|---|---|---|
total_price |
string (decimal) | Total price for the invoice item |
Move invoice item from one invoice to another one
Move invoice item from one invoice to another one.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
InvoiceItemMigrateToRequest - API Source:
invoice_items_migrate_to
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
invoice |
string (uri) | ✓ |
200 -
| Field | Type |
|---|---|
invoice |
string (uri) |
Invoice
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| POST | /api/invoice/send-financial-report-by-mail/ |
Send financial report by mail |
Send financial report by mail
1 2 3 4 5 6 7 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
FinancialReportEmailRequest - API Source:
invoice_send_financial_report_by_mail
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
| Field | Type | Required |
|---|---|---|
emails |
array of string (email)s | ✓ |
year |
integer | ✓ |
month |
integer | ✓ |
200 - No response body
Invoices
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/invoices/ |
List Invoices |
| GET | /api/invoices/{uuid}/ |
Retrieve |
| Other Actions | ||
| GET | /api/invoices/growth/ |
List Invoices Growth |
| GET | /api/invoices/{uuid}/history/at/ |
Get object state at a specific timestamp |
| GET | /api/invoices/{uuid}/history/ |
Get version history |
| GET | /api/invoices/{uuid}/items/ |
Get invoice items |
| GET | /api/invoices/{uuid}/stats/ |
Spendings grouped by offerings and filtered by provider |
| POST | /api/invoices/import_usage/ |
Import usage data |
| POST | /api/invoices/{uuid}/paid/ |
Mark invoice as paid and optionally create payment record with proof of payment |
| POST | /api/invoices/{uuid}/send_notification/ |
Send invoice notification |
| POST | /api/invoices/{uuid}/set_backend_id/ |
Set backend ID for invoice |
| POST | /api/invoices/{uuid}/set_payment_url/ |
Set payment URL for invoice |
| POST | /api/invoices/{uuid}/set_reference_number/ |
Set reference number for invoice |
Core CRUD
List Invoices
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
InvoiceFieldEnum - Model Source:
InvoiceOEnum - Model Source:
InvoiceStateEnum - API Source:
invoices_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
accounting_is_running |
boolean | Filter by whether accounting is running. |
created |
string (date) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
end_date |
string (date) | |
field |
array | |
month |
integer | |
o |
array | Ordering |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
start_date |
string (date) | |
state |
array | |
year |
integer |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
number |
integer | |
customer |
string (uri) | |
price |
string (decimal) | |
tax |
string (decimal) | |
total |
string (decimal) | |
state |
string | Enum: pending, pending_finalization, created, paid, canceled |
year |
integer | |
month |
integer | |
issuer_details |
any | |
invoice_date |
string (date) | Date then invoice moved from state pending to created. |
due_date |
string (date) | |
customer_details |
object | |
customer_details.name |
string | |
customer_details.address |
string | |
customer_details.country |
string | |
customer_details.country_name |
string | |
customer_details.email |
string (email) | |
customer_details.postal |
string | |
customer_details.phone_number |
string | |
customer_details.bank_name |
string | |
customer_details.bank_account |
string | |
customer_details.vat_code |
string | VAT number |
items |
array of objects | |
items.uuid |
string (uuid) | |
items.url |
string (uri) | |
items.name |
string | |
items.price |
number (double) | |
items.tax |
string (decimal) | |
items.total |
string (decimal) | |
items.unit_price |
string (decimal) | |
items.unit |
string | Enum: month, quarter, half_month, day, hour, quantity |
items.factor |
integer | |
items.measured_unit |
string | |
items.start |
string (date-time) | Date and time when item usage has started. |
items.end |
string (date-time) | Date and time when item usage has ended. |
items.article_code |
string | |
items.project_name |
string | |
items.project_uuid |
string (uuid) | |
items.quantity |
string (decimal) | |
items.details |
object | |
items.details.resource_name |
string | Name of the marketplace resource |
items.details.resource_uuid |
string (uuid) | UUID of the marketplace resource |
items.details.plan_name |
string | Name of the pricing plan |
items.details.plan_uuid |
string (uuid) | UUID of the pricing plan |
items.details.offering_type |
string | Type of the offering |
items.details.offering_name |
string | Name of the offering |
items.details.offering_uuid |
string (uuid) | UUID of the offering |
items.details.service_provider_name |
string | Name of the service provider |
items.details.service_provider_uuid |
string (uuid) | UUID of the service provider |
items.details.plan_component_id |
integer | ID of the plan component |
items.details.offering_component_type |
string | Type of the offering component |
items.details.offering_component_name |
string | Name of the offering component |
items.details.resource_limit_periods |
array of objects | List of resource limit periods for this invoice item |
items.details.resource_limit_periods.start |
string | Start date of the resource limit period |
items.details.resource_limit_periods.end |
string | End date of the resource limit period |
items.details.resource_limit_periods.quantity |
integer | Quantity of resources consumed during this period |
items.details.resource_limit_periods.billing_periods |
integer | Number of billing periods |
items.details.resource_limit_periods.total |
string | Total amount for this period |
items.resource |
string (uri) | |
items.resource_uuid |
string (uuid) | |
items.resource_name |
string | |
items.billing_type |
string | |
items.backend_uuid |
string (uuid) | |
items.credit |
boolean | |
backend_id |
string | |
payment_url |
string (uri) | URL for initiating payment via payment gateway. |
reference_number |
string | Reference number associated with the invoice. |
compensations |
number (double) | |
incurred_costs |
number (double) |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
InvoiceFieldEnum - API Source:
invoices_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
number |
integer | |
customer |
string (uri) | |
price |
string (decimal) | |
tax |
string (decimal) | |
total |
string (decimal) | |
state |
string | Enum: pending, pending_finalization, created, paid, canceled |
year |
integer | |
month |
integer | |
issuer_details |
any | |
invoice_date |
string (date) | Date then invoice moved from state pending to created. |
due_date |
string (date) | |
customer_details |
object | |
customer_details.name |
string | |
customer_details.address |
string | |
customer_details.country |
string | |
customer_details.country_name |
string | |
customer_details.email |
string (email) | |
customer_details.postal |
string | |
customer_details.phone_number |
string | |
customer_details.bank_name |
string | |
customer_details.bank_account |
string | |
customer_details.vat_code |
string | VAT number |
items |
array of objects | |
items.uuid |
string (uuid) | |
items.url |
string (uri) | |
items.name |
string | |
items.price |
number (double) | |
items.tax |
string (decimal) | |
items.total |
string (decimal) | |
items.unit_price |
string (decimal) | |
items.unit |
string | Enum: month, quarter, half_month, day, hour, quantity |
items.factor |
integer | |
items.measured_unit |
string | |
items.start |
string (date-time) | Date and time when item usage has started. |
items.end |
string (date-time) | Date and time when item usage has ended. |
items.article_code |
string | |
items.project_name |
string | |
items.project_uuid |
string (uuid) | |
items.quantity |
string (decimal) | |
items.details |
object | |
items.details.resource_name |
string | Name of the marketplace resource |
items.details.resource_uuid |
string (uuid) | UUID of the marketplace resource |
items.details.plan_name |
string | Name of the pricing plan |
items.details.plan_uuid |
string (uuid) | UUID of the pricing plan |
items.details.offering_type |
string | Type of the offering |
items.details.offering_name |
string | Name of the offering |
items.details.offering_uuid |
string (uuid) | UUID of the offering |
items.details.service_provider_name |
string | Name of the service provider |
items.details.service_provider_uuid |
string (uuid) | UUID of the service provider |
items.details.plan_component_id |
integer | ID of the plan component |
items.details.offering_component_type |
string | Type of the offering component |
items.details.offering_component_name |
string | Name of the offering component |
items.details.resource_limit_periods |
array of objects | List of resource limit periods for this invoice item |
items.details.resource_limit_periods.start |
string | Start date of the resource limit period |
items.details.resource_limit_periods.end |
string | End date of the resource limit period |
items.details.resource_limit_periods.quantity |
integer | Quantity of resources consumed during this period |
items.details.resource_limit_periods.billing_periods |
integer | Number of billing periods |
items.details.resource_limit_periods.total |
string | Total amount for this period |
items.resource |
string (uri) | |
items.resource_uuid |
string (uuid) | |
items.resource_name |
string | |
items.billing_type |
string | |
items.backend_uuid |
string (uuid) | |
items.credit |
boolean | |
backend_id |
string | |
payment_url |
string (uri) | URL for initiating payment via payment gateway. |
reference_number |
string | Reference number associated with the invoice. |
compensations |
number (double) | |
incurred_costs |
number (double) |
Other Actions
List Invoices Growth
Analyze invoice trends over time by comparing monthly totals for major customers versus others over the past year.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
- API Source:
invoices_growth_retrieve
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type |
|---|---|
accounting_is_running |
boolean |
accounting_mode |
string |
customers_count |
integer |
200 -
| Field | Type |
|---|---|
periods |
array of strings |
total_periods |
array of number (double)s |
other_periods |
array of number (double)s |
customer_periods |
array of objects |
customer_periods.name |
string |
customer_periods.periods |
array of number (double)s |
Get object state at a specific timestamp
Returns the state of the object as it was at the specified timestamp. Only accessible by staff and support users.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- API Source:
invoices_history_at_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Required | Description |
|---|---|---|---|
timestamp |
string | ✓ | ISO 8601 timestamp to query the object state at |
200 -
| Field | Type | Description |
|---|---|---|
id |
integer | Version ID |
revision_date |
string (date-time) | When this revision was created |
revision_user |
object (free-form) | User who created this revision |
revision_comment |
string | Comment describing the revision |
serialized_data |
object (free-form) | Serialized model fields at this revision |
400 -
404 -
Get version history
Returns the version history for this object. Only accessible by staff and support users.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
- Model Source:
InvoiceOEnum - Model Source:
InvoiceStateEnum - API Source:
invoices_history_list
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
accounting_is_running |
boolean | Filter by whether accounting is running. |
created |
string (date) | |
created_after |
string | Filter versions created after this timestamp (ISO 8601) |
created_before |
string | Filter versions created before this timestamp (ISO 8601) |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
end_date |
string (date) | |
month |
integer | |
o |
array | Ordering |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
start_date |
string (date) | |
state |
array | |
year |
integer |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
id |
integer | Version ID |
revision_date |
string (date-time) | When this revision was created |
revision_user |
object (free-form) | User who created this revision |
revision_comment |
string | Comment describing the revision |
serialized_data |
object (free-form) | Serialized model fields at this revision |
Get invoice items
Retrieve a list of invoice items for the specified invoice.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
InvoiceItemOEnum - API Source:
invoices_items_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
conceal_compensation_items |
boolean | Conceal compensation items |
o |
string | Order results by field Enum: project_name, -project_name, resource_name, -resource_name, provider_name, -provider_name, name, -name |
offering_uuid |
string (uuid) | |
project_uuid |
string (uuid) | |
provider_uuid |
string (uuid) | |
query |
string |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
name |
string | |
price |
number (double) | |
tax |
string (decimal) | |
total |
string (decimal) | |
unit_price |
string (decimal) | |
unit |
string | Enum: month, quarter, half_month, day, hour, quantity |
factor |
integer | |
measured_unit |
string | |
start |
string (date-time) | Date and time when item usage has started. |
end |
string (date-time) | Date and time when item usage has ended. |
article_code |
string | |
project_name |
string | |
project_uuid |
string (uuid) | |
quantity |
string (decimal) | |
details |
object | |
details.resource_name |
string | Name of the marketplace resource |
details.resource_uuid |
string (uuid) | UUID of the marketplace resource |
details.plan_name |
string | Name of the pricing plan |
details.plan_uuid |
string (uuid) | UUID of the pricing plan |
details.offering_type |
string | Type of the offering |
details.offering_name |
string | Name of the offering |
details.offering_uuid |
string (uuid) | UUID of the offering |
details.service_provider_name |
string | Name of the service provider |
details.service_provider_uuid |
string (uuid) | UUID of the service provider |
details.plan_component_id |
integer | ID of the plan component |
details.offering_component_type |
string | Type of the offering component |
details.offering_component_name |
string | Name of the offering component |
details.resource_limit_periods |
array of objects | List of resource limit periods for this invoice item |
details.resource_limit_periods.start |
string | Start date of the resource limit period |
details.resource_limit_periods.end |
string | End date of the resource limit period |
details.resource_limit_periods.quantity |
integer | Quantity of resources consumed during this period |
details.resource_limit_periods.billing_periods |
integer | Number of billing periods |
details.resource_limit_periods.total |
string | Total amount for this period |
resource |
string (uri) | |
resource_uuid |
string (uuid) | |
resource_name |
string | |
billing_type |
string | |
backend_uuid |
string (uuid) | |
credit |
boolean |
Spendings grouped by offerings and filtered by provider
Spendings grouped by offerings and filtered by provider.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
- Model Source:
InvoiceOEnum - Model Source:
InvoiceStateEnum - API Source:
invoices_stats_list
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
accounting_is_running |
boolean | Filter by whether accounting is running. |
created |
string (date) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
end_date |
string (date) | |
month |
integer | |
o |
array | Ordering |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
provider_uuid |
string (uuid) | |
start_date |
string (date) | |
state |
array | |
year |
integer |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
offering_name |
string |
aggregated_price |
number (double) |
aggregated_tax |
number (double) |
aggregated_total |
number (double) |
service_category_title |
string |
service_provider_name |
string |
service_provider_uuid |
string (uuid) |
Import usage data
Import component usage items as JSON data for multiple customers. Creates invoice items for the specified billing period. Items are deduplicated by name, customer, and billing period to prevent duplicates.
1 2 3 4 5 6 7 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
ImportUsageRequest - API Source:
invoices_import_usage
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
| Field | Type | Required |
|---|---|---|
year |
integer | ✓ |
month |
integer | ✓ |
items |
array of objects | ✓ |
items.customer_name |
string | |
items.customer_uuid |
string (uuid) | |
items.name |
string | ✓ |
items.unit_price |
string (decimal) | ✓ |
items.article_code |
string | |
items.service_provider_name |
string | |
items.offering_name |
string | |
items.plan_name |
string |
200 -
| Field | Type |
|---|---|
created |
integer |
skipped |
integer |
errors |
array of objects |
Mark invoice as paid and optionally create payment record with proof of payment
Mark invoice as paid and optionally create payment record with proof of payment.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
PaidRequest - API Source:
invoices_paid
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
date |
string (date) | ✓ |
proof |
string (binary) |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
number |
integer | |
customer |
string (uri) | |
price |
string (decimal) | |
tax |
string (decimal) | |
total |
string (decimal) | |
state |
string | Enum: pending, pending_finalization, created, paid, canceled |
year |
integer | |
month |
integer | |
issuer_details |
any | |
invoice_date |
string (date) | Date then invoice moved from state pending to created. |
due_date |
string (date) | |
customer_details |
object | |
customer_details.name |
string | |
customer_details.address |
string | |
customer_details.country |
string | |
customer_details.country_name |
string | |
customer_details.email |
string (email) | |
customer_details.postal |
string | |
customer_details.phone_number |
string | |
customer_details.bank_name |
string | |
customer_details.bank_account |
string | |
customer_details.vat_code |
string | VAT number |
items |
array of objects | |
items.uuid |
string (uuid) | |
items.url |
string (uri) | |
items.name |
string | |
items.price |
number (double) | |
items.tax |
string (decimal) | |
items.total |
string (decimal) | |
items.unit_price |
string (decimal) | |
items.unit |
string | Enum: month, quarter, half_month, day, hour, quantity |
items.factor |
integer | |
items.measured_unit |
string | |
items.start |
string (date-time) | Date and time when item usage has started. |
items.end |
string (date-time) | Date and time when item usage has ended. |
items.article_code |
string | |
items.project_name |
string | |
items.project_uuid |
string (uuid) | |
items.quantity |
string (decimal) | |
items.details |
object | |
items.details.resource_name |
string | Name of the marketplace resource |
items.details.resource_uuid |
string (uuid) | UUID of the marketplace resource |
items.details.plan_name |
string | Name of the pricing plan |
items.details.plan_uuid |
string (uuid) | UUID of the pricing plan |
items.details.offering_type |
string | Type of the offering |
items.details.offering_name |
string | Name of the offering |
items.details.offering_uuid |
string (uuid) | UUID of the offering |
items.details.service_provider_name |
string | Name of the service provider |
items.details.service_provider_uuid |
string (uuid) | UUID of the service provider |
items.details.plan_component_id |
integer | ID of the plan component |
items.details.offering_component_type |
string | Type of the offering component |
items.details.offering_component_name |
string | Name of the offering component |
items.details.resource_limit_periods |
array of objects | List of resource limit periods for this invoice item |
items.details.resource_limit_periods.start |
string | Start date of the resource limit period |
items.details.resource_limit_periods.end |
string | End date of the resource limit period |
items.details.resource_limit_periods.quantity |
integer | Quantity of resources consumed during this period |
items.details.resource_limit_periods.billing_periods |
integer | Number of billing periods |
items.details.resource_limit_periods.total |
string | Total amount for this period |
items.resource |
string (uri) | |
items.resource_uuid |
string (uuid) | |
items.resource_name |
string | |
items.billing_type |
string | |
items.backend_uuid |
string (uuid) | |
items.credit |
boolean | |
backend_id |
string | |
payment_url |
string (uri) | URL for initiating payment via payment gateway. |
reference_number |
string | Reference number associated with the invoice. |
compensations |
number (double) | |
incurred_costs |
number (double) |
Send invoice notification
Schedule sending of a notification for the specified invoice.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
invoices_send_notification
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - No response body
Set backend ID for invoice
Set backend ID for invoice.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
BackendIdRequest - API Source:
invoices_set_backend_id
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
backend_id |
string |
200 - No response body
Set payment URL for invoice
Set payment URL for invoice.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PaymentURLRequest - API Source:
invoices_set_payment_url
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
payment_url |
string (uri) | URL for initiating payment via payment gateway. |
200 - No response body
Set reference number for invoice
Set reference number for invoice.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
ReferenceNumberRequest - API Source:
invoices_set_reference_number
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
reference_number |
string | Reference number associated with the invoice. |
200 - No response body
Payment Profiles
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/payment-profiles/ |
List Payment Profiles |
| GET | /api/payment-profiles/{uuid}/ |
Retrieve |
| POST | /api/payment-profiles/ |
Create |
| PUT | /api/payment-profiles/{uuid}/ |
Update |
| PATCH | /api/payment-profiles/{uuid}/ |
Partial Update |
| DELETE | /api/payment-profiles/{uuid}/ |
Delete |
| Other Actions | ||
| POST | /api/payment-profiles/{uuid}/enable/ |
Enable |
Core CRUD
List Payment Profiles
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- Model Source:
PaymentProfileOEnum - Model Source:
PaymentTypeEnum - API Source:
payment_profiles_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
is_active |
boolean | |
o |
array | Ordering |
organization |
string (uri) | |
organization_uuid |
string (uuid) | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
payment_type |
array |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
uuid |
string (uuid) |
url |
string (uri) |
name |
string |
organization_uuid |
string (uuid) |
organization |
string (uri) |
attributes |
object |
attributes.end_date |
string |
attributes.agreement_number |
string |
attributes.contract_sum |
integer |
payment_type |
string |
payment_type_display |
string |
is_active |
boolean |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
payment_profiles_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
url |
string (uri) |
name |
string |
organization_uuid |
string (uuid) |
organization |
string (uri) |
attributes |
object |
attributes.end_date |
string |
attributes.agreement_number |
string |
attributes.contract_sum |
integer |
payment_type |
string |
payment_type_display |
string |
is_active |
boolean |
Create
1 2 3 4 5 6 7 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
PaymentProfileRequest - API Source:
payment_profiles_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
| Field | Type | Required |
|---|---|---|
name |
string | ✓ |
organization |
string (uri) | ✓ |
attributes |
object | |
attributes.end_date |
string | |
attributes.agreement_number |
string | |
attributes.contract_sum |
integer | |
payment_type |
string | ✓ |
is_active |
boolean |
201 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
url |
string (uri) |
name |
string |
organization_uuid |
string (uuid) |
organization |
string (uri) |
attributes |
object |
attributes.end_date |
string |
attributes.agreement_number |
string |
attributes.contract_sum |
integer |
payment_type |
string |
payment_type_display |
string |
is_active |
boolean |
Update
1 2 3 4 5 6 7 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | |
- Model Source:
PaymentProfileRequest - API Source:
payment_profiles_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
name |
string | ✓ |
organization |
string (uri) | ✓ |
attributes |
object | |
attributes.end_date |
string | |
attributes.agreement_number |
string | |
attributes.contract_sum |
integer | |
payment_type |
string | ✓ |
is_active |
boolean |
200 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
url |
string (uri) |
name |
string |
organization_uuid |
string (uuid) |
organization |
string (uri) |
attributes |
object |
attributes.end_date |
string |
attributes.agreement_number |
string |
attributes.contract_sum |
integer |
payment_type |
string |
payment_type_display |
string |
is_active |
boolean |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedPaymentProfileRequest - API Source:
payment_profiles_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
name |
string | |
organization |
string (uri) | |
attributes |
object | |
attributes.end_date |
string | |
attributes.agreement_number |
string | |
attributes.contract_sum |
integer | |
payment_type |
string | |
is_active |
boolean |
200 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
url |
string (uri) |
name |
string |
organization_uuid |
string (uuid) |
organization |
string (uri) |
attributes |
object |
attributes.end_date |
string |
attributes.agreement_number |
string |
attributes.contract_sum |
integer |
payment_type |
string |
payment_type_display |
string |
is_active |
boolean |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
payment_profiles_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
Enable
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
payment_profiles_enable
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - No response body
Payments
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/payments/ |
List Payments |
| GET | /api/payments/{uuid}/ |
Retrieve |
| POST | /api/payments/ |
Create |
| POST | /api/payments/{uuid}/unlink_from_invoice/ |
Unlink from invoice |
| PUT | /api/payments/{uuid}/ |
Update |
| PATCH | /api/payments/{uuid}/ |
Partial Update |
| DELETE | /api/payments/{uuid}/ |
Delete |
| Other Actions | ||
| POST | /api/payments/{uuid}/link_to_invoice/ |
Link to invoice |
Core CRUD
List Payments
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
payments_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
date_of_payment |
string (date) | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
profile |
string (uri) | |
profile_uuid |
string (uuid) |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
uuid |
string (uuid) |
url |
string (uri) |
profile |
string (uri) |
date_of_payment |
string (date) |
sum |
string (decimal) |
proof |
string (uri) |
invoice |
string (uri) |
invoice_uuid |
string (uuid) |
invoice_period |
string |
customer_uuid |
string (uuid) |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
payments_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
url |
string (uri) |
profile |
string (uri) |
date_of_payment |
string (date) |
sum |
string (decimal) |
proof |
string (uri) |
invoice |
string (uri) |
invoice_uuid |
string (uuid) |
invoice_period |
string |
customer_uuid |
string (uuid) |
Create
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
PaymentRequest - API Source:
payments_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Field | Type | Required |
|---|---|---|
profile |
string (uri) | ✓ |
date_of_payment |
string (date) | ✓ |
sum |
string (decimal) | |
proof |
string (binary) |
201 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
url |
string (uri) |
profile |
string (uri) |
date_of_payment |
string (date) |
sum |
string (decimal) |
proof |
string (uri) |
invoice |
string (uri) |
invoice_uuid |
string (uuid) |
invoice_period |
string |
customer_uuid |
string (uuid) |
Unlink from invoice
Unlink a payment from an invoice. Remove connection between payment and existing linked invoice.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
payments_unlink_from_invoice
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - No response body
Update
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
PaymentRequest - API Source:
payments_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
profile |
string (uri) | ✓ |
date_of_payment |
string (date) | ✓ |
sum |
string (decimal) | |
proof |
string (binary) |
200 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
url |
string (uri) |
profile |
string (uri) |
date_of_payment |
string (date) |
sum |
string (decimal) |
proof |
string (uri) |
invoice |
string (uri) |
invoice_uuid |
string (uuid) |
invoice_period |
string |
customer_uuid |
string (uuid) |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedPaymentRequest - API Source:
payments_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
profile |
string (uri) | |
date_of_payment |
string (date) | |
sum |
string (decimal) | |
proof |
string (binary) |
200 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
url |
string (uri) |
profile |
string (uri) |
date_of_payment |
string (date) |
sum |
string (decimal) |
proof |
string (uri) |
invoice |
string (uri) |
invoice_uuid |
string (uuid) |
invoice_period |
string |
customer_uuid |
string (uuid) |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
payments_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
Link to invoice
Link a payment to an invoice. Payment can be linked to an invoice only if they belong to the same customer.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
LinkToInvoiceRequest - API Source:
payments_link_to_invoice
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
invoice |
string (uri) | ✓ |
200 -
| Field | Type |
|---|---|
invoice |
string (uri) |
Project Credits
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/project-credits/ |
List Project Credits |
| GET | /api/project-credits/{uuid}/ |
Retrieve |
| POST | /api/project-credits/ |
Create |
| PUT | /api/project-credits/{uuid}/ |
Update |
| PATCH | /api/project-credits/{uuid}/ |
Partial Update |
| DELETE | /api/project-credits/{uuid}/ |
Delete |
List Project Credits
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 | |
- Model Source:
ProjectCreditOEnum - API Source:
project_credits_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
customer_name |
string | |
customer_slug |
string | |
customer_uuid |
string (uuid) | |
o |
array | Ordering |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
project_name |
string | |
project_uuid |
string (uuid) | |
query |
string |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
uuid |
string (uuid) |
url |
string (uri) |
value |
string (decimal) |
project |
string (uri) |
project_name |
string |
project_uuid |
string (uuid) |
project_slug |
string |
customer_name |
string |
customer_slug |
string |
customer_uuid |
string (uuid) |
customer_credit |
string (decimal) |
allocated_customer_credit |
number (double) |
consumption_last_month |
number (double) |
offerings |
array of objects |
offerings.uuid |
string (uuid) |
offerings.url |
string (uri) |
offerings.type |
string |
offerings.name |
string |
end_date |
string (date) |
expected_consumption |
string (decimal) |
minimal_consumption |
number (double) |
minimal_consumption_logic |
string |
grace_coefficient |
string (decimal) |
apply_as_minimal_consumption |
boolean |
mark_unused_credit_as_spent_on_project_termination |
boolean |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
project_credits_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
url |
string (uri) |
value |
string (decimal) |
project |
string (uri) |
project_name |
string |
project_uuid |
string (uuid) |
project_slug |
string |
customer_name |
string |
customer_slug |
string |
customer_uuid |
string (uuid) |
customer_credit |
string (decimal) |
allocated_customer_credit |
number (double) |
consumption_last_month |
number (double) |
offerings |
array of objects |
offerings.uuid |
string (uuid) |
offerings.url |
string (uri) |
offerings.type |
string |
offerings.name |
string |
end_date |
string (date) |
expected_consumption |
string (decimal) |
minimal_consumption |
number (double) |
minimal_consumption_logic |
string |
grace_coefficient |
string (decimal) |
apply_as_minimal_consumption |
boolean |
mark_unused_credit_as_spent_on_project_termination |
boolean |
Create
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
- Model Source:
ProjectCreditRequest - API Source:
project_credits_create
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Field | Type | Required |
|---|---|---|
value |
string (decimal) | |
project |
string (uri) | ✓ |
end_date |
string (date) | |
expected_consumption |
string (decimal) | |
minimal_consumption_logic |
string | |
grace_coefficient |
string (decimal) | |
apply_as_minimal_consumption |
boolean | |
mark_unused_credit_as_spent_on_project_termination |
boolean |
201 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
url |
string (uri) |
value |
string (decimal) |
project |
string (uri) |
project_name |
string |
project_uuid |
string (uuid) |
project_slug |
string |
customer_name |
string |
customer_slug |
string |
customer_uuid |
string (uuid) |
customer_credit |
string (decimal) |
allocated_customer_credit |
number (double) |
consumption_last_month |
number (double) |
offerings |
array of objects |
offerings.uuid |
string (uuid) |
offerings.url |
string (uri) |
offerings.type |
string |
offerings.name |
string |
end_date |
string (date) |
expected_consumption |
string (decimal) |
minimal_consumption |
number (double) |
minimal_consumption_logic |
string |
grace_coefficient |
string (decimal) |
apply_as_minimal_consumption |
boolean |
mark_unused_credit_as_spent_on_project_termination |
boolean |
Update
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
ProjectCreditRequest - API Source:
project_credits_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
value |
string (decimal) | |
project |
string (uri) | ✓ |
end_date |
string (date) | |
expected_consumption |
string (decimal) | |
minimal_consumption_logic |
string | |
grace_coefficient |
string (decimal) | |
apply_as_minimal_consumption |
boolean | |
mark_unused_credit_as_spent_on_project_termination |
boolean |
200 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
url |
string (uri) |
value |
string (decimal) |
project |
string (uri) |
project_name |
string |
project_uuid |
string (uuid) |
project_slug |
string |
customer_name |
string |
customer_slug |
string |
customer_uuid |
string (uuid) |
customer_credit |
string (decimal) |
allocated_customer_credit |
number (double) |
consumption_last_month |
number (double) |
offerings |
array of objects |
offerings.uuid |
string (uuid) |
offerings.url |
string (uri) |
offerings.type |
string |
offerings.name |
string |
end_date |
string (date) |
expected_consumption |
string (decimal) |
minimal_consumption |
number (double) |
minimal_consumption_logic |
string |
grace_coefficient |
string (decimal) |
apply_as_minimal_consumption |
boolean |
mark_unused_credit_as_spent_on_project_termination |
boolean |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedProjectCreditRequest - API Source:
project_credits_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
value |
string (decimal) | |
project |
string (uri) | |
end_date |
string (date) | |
expected_consumption |
string (decimal) | |
minimal_consumption_logic |
string | |
grace_coefficient |
string (decimal) | |
apply_as_minimal_consumption |
boolean | |
mark_unused_credit_as_spent_on_project_termination |
boolean |
200 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
url |
string (uri) |
value |
string (decimal) |
project |
string (uri) |
project_name |
string |
project_uuid |
string (uuid) |
project_slug |
string |
customer_name |
string |
customer_slug |
string |
customer_uuid |
string (uuid) |
customer_credit |
string (decimal) |
allocated_customer_credit |
number (double) |
consumption_last_month |
number (double) |
offerings |
array of objects |
offerings.uuid |
string (uuid) |
offerings.url |
string (uri) |
offerings.type |
string |
offerings.name |
string |
end_date |
string (date) |
expected_consumption |
string (decimal) |
minimal_consumption |
number (double) |
minimal_consumption_logic |
string |
grace_coefficient |
string (decimal) |
apply_as_minimal_consumption |
boolean |
mark_unused_credit_as_spent_on_project_termination |
boolean |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
project_credits_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Provider Invoice Items
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/provider-invoice-items/ |
List Provider Invoice Items |
| GET | /api/provider-invoice-items/{id}/ |
Retrieve |
List Provider Invoice Items
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 | |
- Model Source:
InvoiceItemOEnum1 - API Source:
provider_invoice_items_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
customer_uuid |
string (uuid) | Customer UUID |
invoice_month |
integer | Invoice month |
invoice_year |
integer | Invoice year |
o |
array | Ordering |
offering_uuid |
string (uuid) | Offering UUID |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
project_uuid |
string (uuid) | Project UUID |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
name |
string | |
price |
number (double) | |
tax |
string (decimal) | |
total |
string (decimal) | |
unit_price |
string (decimal) | |
unit |
string | Enum: month, quarter, half_month, day, hour, quantity |
factor |
integer | |
measured_unit |
string | |
start |
string (date-time) | Date and time when item usage has started. |
end |
string (date-time) | Date and time when item usage has ended. |
article_code |
string | |
project_name |
string | |
project_uuid |
string (uuid) | |
quantity |
string (decimal) | |
details |
object | |
details.resource_name |
string | Name of the marketplace resource |
details.resource_uuid |
string (uuid) | UUID of the marketplace resource |
details.plan_name |
string | Name of the pricing plan |
details.plan_uuid |
string (uuid) | UUID of the pricing plan |
details.offering_type |
string | Type of the offering |
details.offering_name |
string | Name of the offering |
details.offering_uuid |
string (uuid) | UUID of the offering |
details.service_provider_name |
string | Name of the service provider |
details.service_provider_uuid |
string (uuid) | UUID of the service provider |
details.plan_component_id |
integer | ID of the plan component |
details.offering_component_type |
string | Type of the offering component |
details.offering_component_name |
string | Name of the offering component |
details.resource_limit_periods |
array of objects | List of resource limit periods for this invoice item |
details.resource_limit_periods.start |
string | Start date of the resource limit period |
details.resource_limit_periods.end |
string | End date of the resource limit period |
details.resource_limit_periods.quantity |
integer | Quantity of resources consumed during this period |
details.resource_limit_periods.billing_periods |
integer | Number of billing periods |
details.resource_limit_periods.total |
string | Total amount for this period |
resource |
string (uri) | |
resource_uuid |
string (uuid) | |
resource_name |
string | |
billing_type |
string | |
backend_uuid |
string (uuid) | |
credit |
boolean |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
provider_invoice_items_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required | Description |
|---|---|---|---|
id |
integer | ✓ | A unique integer value identifying this invoice item. |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
name |
string | |
price |
number (double) | |
tax |
string (decimal) | |
total |
string (decimal) | |
unit_price |
string (decimal) | |
unit |
string | Enum: month, quarter, half_month, day, hour, quantity |
factor |
integer | |
measured_unit |
string | |
start |
string (date-time) | Date and time when item usage has started. |
end |
string (date-time) | Date and time when item usage has ended. |
article_code |
string | |
project_name |
string | |
project_uuid |
string (uuid) | |
quantity |
string (decimal) | |
details |
object | |
details.resource_name |
string | Name of the marketplace resource |
details.resource_uuid |
string (uuid) | UUID of the marketplace resource |
details.plan_name |
string | Name of the pricing plan |
details.plan_uuid |
string (uuid) | UUID of the pricing plan |
details.offering_type |
string | Type of the offering |
details.offering_name |
string | Name of the offering |
details.offering_uuid |
string (uuid) | UUID of the offering |
details.service_provider_name |
string | Name of the service provider |
details.service_provider_uuid |
string (uuid) | UUID of the service provider |
details.plan_component_id |
integer | ID of the plan component |
details.offering_component_type |
string | Type of the offering component |
details.offering_component_name |
string | Name of the offering component |
details.resource_limit_periods |
array of objects | List of resource limit periods for this invoice item |
details.resource_limit_periods.start |
string | Start date of the resource limit period |
details.resource_limit_periods.end |
string | End date of the resource limit period |
details.resource_limit_periods.quantity |
integer | Quantity of resources consumed during this period |
details.resource_limit_periods.billing_periods |
integer | Number of billing periods |
details.resource_limit_periods.total |
string | Total amount for this period |
resource |
string (uri) | |
resource_uuid |
string (uuid) | |
resource_name |
string | |
billing_type |
string | |
backend_uuid |
string (uuid) | |
credit |
boolean |
Reporting and analytics
Billing Total Cost
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/billing-total-cost/ |
List Billing Total Cost |
List Billing Total Cost
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
- API Source:
billing_total_cost_retrieve
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type |
|---|---|
accounting_is_running |
boolean |
customer_uuid |
string (uuid) |
month |
integer |
name |
string |
year |
integer |
200 -
| Field | Type |
|---|---|
total |
number (double) |
price |
number (double) |
Customer Quotas
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/customer-quotas/ |
List customer quotas |
List customer quotas
List customer quotas.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
customer_quotas_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
customer_name |
string |
customer_abbreviation |
string |
value |
integer |
Daily Quotas
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/daily-quotas/ |
List Daily Quotas |
List Daily Quotas
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
- API Source:
daily_quotas_retrieve
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
end |
string (date) | End date in format YYYY-MM-DD |
quota_names |
array | List of quota names |
scope |
string (uuid) | UUID of the scope object |
start |
string (date) | Start date in format YYYY-MM-DD |
200 -
Financial Reports
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/financial-reports/ |
List Financial Reports |
| GET | /api/financial-reports/{uuid}/ |
Retrieve |
List Financial Reports
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
financial_reports_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
abbreviation |
string | Abbreviation |
accounting_is_running |
boolean | Filter by whether accounting is running. |
agreement_number |
string | |
archived |
boolean | |
backend_id |
string | |
contact_details |
string | Contact details |
current_user_has_project_create_permission |
boolean | Return a list of customers where current user has project create permission. |
customer_uuid |
string (uuid) | Filter by customer UUID. |
month |
integer | Filter by month. |
name |
string | Name |
name_exact |
string | Name (exact) |
native_name |
string | Native name |
o |
string | Which field to use when ordering the results. |
organization_group_name |
string | Organization group name |
organization_group_uuid |
array | Organization group UUID |
owned_by_current_user |
boolean | Return a list of customers where current user is owner. |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
query |
string | Filter by name, native name, abbreviation, domain, UUID, registration code or agreement number |
registration_code |
string | |
year |
integer | Filter by year. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
name |
string |
uuid |
string (uuid) |
abbreviation |
string |
created |
string (date-time) |
accounting_start_date |
string (date-time) |
registration_code |
string |
agreement_number |
string |
payment_profiles |
array of objects |
payment_profiles.uuid |
string (uuid) |
payment_profiles.url |
string (uri) |
payment_profiles.name |
string |
payment_profiles.organization_uuid |
string (uuid) |
payment_profiles.organization |
string (uri) |
payment_profiles.attributes |
object |
payment_profiles.attributes.end_date |
string |
payment_profiles.attributes.agreement_number |
string |
payment_profiles.attributes.contract_sum |
integer |
payment_profiles.payment_type |
string |
payment_profiles.payment_type_display |
string |
payment_profiles.is_active |
boolean |
billing_price_estimate |
any |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
financial_reports_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
name |
string |
uuid |
string (uuid) |
abbreviation |
string |
created |
string (date-time) |
accounting_start_date |
string (date-time) |
registration_code |
string |
agreement_number |
string |
payment_profiles |
array of objects |
payment_profiles.uuid |
string (uuid) |
payment_profiles.url |
string (uri) |
payment_profiles.name |
string |
payment_profiles.organization_uuid |
string (uuid) |
payment_profiles.organization |
string (uri) |
payment_profiles.attributes |
object |
payment_profiles.attributes.end_date |
string |
payment_profiles.attributes.agreement_number |
string |
payment_profiles.attributes.contract_sum |
integer |
payment_profiles.payment_type |
string |
payment_profiles.payment_type_display |
string |
payment_profiles.is_active |
boolean |
billing_price_estimate |
any |
Project Quotas
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/project-quotas/ |
List project quotas |
List project quotas
List project quotas.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
project_quotas_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
project_name |
string |
customer_name |
string |
customer_abbreviation |
string |
value |
integer |
Cloud and hpc providers
Aws
Aws Images
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/aws-images/ |
List Aws Images |
| GET | /api/aws-images/{uuid}/ |
Retrieve |
List Aws Images
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
aws_images_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
name |
string | Name |
name_exact |
string | Name (exact) |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
region |
string (uuid) |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
region |
any |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
aws_images_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
region |
any |
Aws Instances
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/aws-instances/ |
List Aws Instances |
| GET | /api/aws-instances/{uuid}/ |
Retrieve |
| POST | /api/aws-instances/ |
Create |
| POST | /api/aws-instances/{uuid}/pull/ |
Synchronize resource state |
| POST | /api/aws-instances/{uuid}/unlink/ |
Unlink resource |
| PUT | /api/aws-instances/{uuid}/ |
Update |
| PATCH | /api/aws-instances/{uuid}/ |
Partial Update |
| DELETE | /api/aws-instances/{uuid}/ |
Delete |
| Other Actions | ||
| POST | /api/aws-instances/{uuid}/resize/ |
Resize |
| POST | /api/aws-instances/{uuid}/restart/ |
Restart |
| POST | /api/aws-instances/{uuid}/set_erred/ |
Mark resource as ERRED |
| POST | /api/aws-instances/{uuid}/set_ok/ |
Mark resource as OK |
| POST | /api/aws-instances/{uuid}/start/ |
Start |
| POST | /api/aws-instances/{uuid}/stop/ |
Stop |
Core CRUD
List Aws Instances
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- Model Source:
AwsInstanceFieldEnum - Model Source:
CoreStates - API Source:
aws_instances_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
backend_id |
string | Backend ID |
can_manage |
boolean | Can manage |
customer |
string (uuid) | Customer UUID |
customer_abbreviation |
string | Customer abbreviation |
customer_name |
string | Customer name |
customer_native_name |
string | Customer native name |
customer_uuid |
string (uuid) | Customer UUID |
description |
string | Description |
external_ip |
string | |
field |
array | |
name |
string | Name |
name_exact |
string | Name (exact) |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
project |
string (uuid) | Project UUID |
project_name |
string | Project name |
project_uuid |
string (uuid) | Project UUID |
service_settings_name |
string | Service settings name |
service_settings_uuid |
string (uuid) | Service settings UUID |
state |
array | State |
uuid |
string (uuid) | UUID |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
start_time |
string (date-time) | |
cores |
integer | Number of cores in a VM |
ram |
integer | Memory size in MiB |
disk |
integer | Disk size in MiB |
min_ram |
integer | Minimum memory size in MiB |
min_disk |
integer | Minimum disk size in MiB |
user_data |
string | Additional data that will be added to instance on provisioning |
external_ips |
array of string (ipv4)s | |
internal_ips |
array of string (ipv4)s | |
latitude |
number (double) | |
longitude |
number (double) | |
key_name |
string | |
key_fingerprint |
string | |
image_name |
string | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
AwsInstanceFieldEnum - API Source:
aws_instances_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
start_time |
string (date-time) | |
cores |
integer | Number of cores in a VM |
ram |
integer | Memory size in MiB |
disk |
integer | Disk size in MiB |
min_ram |
integer | Minimum memory size in MiB |
min_disk |
integer | Minimum disk size in MiB |
user_data |
string | Additional data that will be added to instance on provisioning |
external_ips |
array of string (ipv4)s | |
internal_ips |
array of string (ipv4)s | |
latitude |
number (double) | |
longitude |
number (double) | |
key_name |
string | |
key_fingerprint |
string | |
image_name |
string | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Create
1 2 3 4 5 6 7 8 9 10 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 | |
- Model Source:
AwsInstanceRequest - API Source:
aws_instances_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ✓ | |
description |
string | ||
service_settings |
string (uri) | ✓ | |
project |
string (uri) | ✓ | |
ssh_public_key |
string (uri) | Constraints: write-only |
|
user_data |
string | Additional data that will be added to instance on provisioning | |
region |
string (uri) | ✓ | Constraints: write-only |
image |
string (uri) | ✓ | Constraints: write-only |
size |
string (uri) | ✓ | Constraints: write-only |
201 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
start_time |
string (date-time) | |
cores |
integer | Number of cores in a VM |
ram |
integer | Memory size in MiB |
disk |
integer | Disk size in MiB |
min_ram |
integer | Minimum memory size in MiB |
min_disk |
integer | Minimum disk size in MiB |
user_data |
string | Additional data that will be added to instance on provisioning |
external_ips |
array of string (ipv4)s | |
internal_ips |
array of string (ipv4)s | |
latitude |
number (double) | |
longitude |
number (double) | |
key_name |
string | |
key_fingerprint |
string | |
image_name |
string | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Synchronize resource state
Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
aws_instances_pull
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
202 -
| Field | Type |
|---|---|
detail |
string |
409 -
| Field | Type |
|---|---|
detail |
string |
Unlink resource
Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
aws_instances_unlink
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Update
1 2 3 4 5 6 7 8 9 10 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 | |
- Model Source:
AwsInstanceRequest - API Source:
aws_instances_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ✓ | |
description |
string | ||
service_settings |
string (uri) | ✓ | |
project |
string (uri) | ✓ | |
ssh_public_key |
string (uri) | Constraints: write-only |
|
user_data |
string | Additional data that will be added to instance on provisioning | |
region |
string (uri) | ✓ | Constraints: write-only |
image |
string (uri) | ✓ | Constraints: write-only |
size |
string (uri) | ✓ | Constraints: write-only |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
start_time |
string (date-time) | |
cores |
integer | Number of cores in a VM |
ram |
integer | Memory size in MiB |
disk |
integer | Disk size in MiB |
min_ram |
integer | Minimum memory size in MiB |
min_disk |
integer | Minimum disk size in MiB |
user_data |
string | Additional data that will be added to instance on provisioning |
external_ips |
array of string (ipv4)s | |
internal_ips |
array of string (ipv4)s | |
latitude |
number (double) | |
longitude |
number (double) | |
key_name |
string | |
key_fingerprint |
string | |
image_name |
string | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedAwsInstanceRequest - API Source:
aws_instances_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
name |
string | |
description |
string |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
start_time |
string (date-time) | |
cores |
integer | Number of cores in a VM |
ram |
integer | Memory size in MiB |
disk |
integer | Disk size in MiB |
min_ram |
integer | Minimum memory size in MiB |
min_disk |
integer | Minimum disk size in MiB |
user_data |
string | Additional data that will be added to instance on provisioning |
external_ips |
array of string (ipv4)s | |
internal_ips |
array of string (ipv4)s | |
latitude |
number (double) | |
longitude |
number (double) | |
key_name |
string | |
key_fingerprint |
string | |
image_name |
string | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
aws_instances_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
Resize
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
AwsInstanceResizeRequest - API Source:
aws_instances_resize
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
size |
string (uri) | ✓ |
200 -
| Field | Type |
|---|---|
size |
string (uri) |
Restart
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
aws_instances_restart
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - No response body
Mark resource as ERRED
Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
SetErredRequest - API Source:
aws_instances_set_erred
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
error_message |
string | |
error_traceback |
string |
200 -
| Field | Type |
|---|---|
detail |
string |
Mark resource as OK
Manually transition the resource to OK state and clear error fields. Staff-only operation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
aws_instances_set_ok
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
detail |
string |
Start
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
aws_instances_start
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - No response body
Stop
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
aws_instances_stop
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - No response body
Aws Regions
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/aws-regions/ |
List Aws Regions |
| GET | /api/aws-regions/{uuid}/ |
Retrieve |
List Aws Regions
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
aws_regions_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
name |
string | Name |
name_exact |
string | Name (exact) |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
aws_regions_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
Aws Sizes
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/aws-sizes/ |
List Aws Sizes |
| GET | /api/aws-sizes/{uuid}/ |
Retrieve |
List Aws Sizes
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
aws_sizes_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
name |
string | Name |
name_exact |
string | Name (exact) |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
region |
string (uuid) |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
cores |
integer | Number of cores in a VM |
ram |
integer | Memory size in MiB |
disk |
integer | Disk size in MiB |
regions |
array of objects | |
regions.url |
string (uri) | |
regions.uuid |
string (uuid) | |
regions.name |
string | |
description |
string |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
aws_sizes_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
cores |
integer | Number of cores in a VM |
ram |
integer | Memory size in MiB |
disk |
integer | Disk size in MiB |
regions |
array of objects | |
regions.url |
string (uri) | |
regions.uuid |
string (uuid) | |
regions.name |
string | |
description |
string |
Aws Volumes
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/aws-volumes/ |
List Aws Volumes |
| GET | /api/aws-volumes/{uuid}/ |
Retrieve |
| POST | /api/aws-volumes/ |
Create |
| POST | /api/aws-volumes/{uuid}/pull/ |
Synchronize resource state |
| POST | /api/aws-volumes/{uuid}/unlink/ |
Unlink resource |
| PUT | /api/aws-volumes/{uuid}/ |
Update |
| PATCH | /api/aws-volumes/{uuid}/ |
Partial Update |
| DELETE | /api/aws-volumes/{uuid}/ |
Delete |
| Other Actions | ||
| POST | /api/aws-volumes/{uuid}/attach/ |
Attach |
| POST | /api/aws-volumes/{uuid}/detach/ |
Detach |
| POST | /api/aws-volumes/{uuid}/set_erred/ |
Mark resource as ERRED |
| POST | /api/aws-volumes/{uuid}/set_ok/ |
Mark resource as OK |
Core CRUD
List Aws Volumes
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 | |
- Model Source:
AwsVolumeFieldEnum - API Source:
aws_volumes_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
field |
array | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
size |
integer | Size of volume in gigabytes |
volume_type |
string | Enum: gp2, io1, standard |
device |
string | |
instance |
string (uri) | |
runtime_state |
string | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
AwsVolumeFieldEnum - API Source:
aws_volumes_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
size |
integer | Size of volume in gigabytes |
volume_type |
string | Enum: gp2, io1, standard |
device |
string | |
instance |
string (uri) | |
runtime_state |
string | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Create
1 2 3 4 5 6 7 8 9 10 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 | |
- Model Source:
AwsVolumeRequest - API Source:
aws_volumes_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ✓ | |
description |
string | ||
service_settings |
string (uri) | ✓ | |
project |
string (uri) | ✓ | |
size |
integer | ✓ | Size of volume in gigabytes |
region |
string (uri) | ✓ | Constraints: write-only |
volume_type |
string | ✓ | Enum: gp2, io1, standard |
201 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
size |
integer | Size of volume in gigabytes |
volume_type |
string | Enum: gp2, io1, standard |
device |
string | |
instance |
string (uri) | |
runtime_state |
string | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Synchronize resource state
Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
aws_volumes_pull
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
202 -
| Field | Type |
|---|---|
detail |
string |
409 -
| Field | Type |
|---|---|
detail |
string |
Unlink resource
Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
aws_volumes_unlink
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Update
1 2 3 4 5 6 7 8 9 10 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 | |
- Model Source:
AwsVolumeRequest - API Source:
aws_volumes_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ✓ | |
description |
string | ||
service_settings |
string (uri) | ✓ | |
project |
string (uri) | ✓ | |
size |
integer | ✓ | Size of volume in gigabytes |
region |
string (uri) | ✓ | Constraints: write-only |
volume_type |
string | ✓ | Enum: gp2, io1, standard |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
size |
integer | Size of volume in gigabytes |
volume_type |
string | Enum: gp2, io1, standard |
device |
string | |
instance |
string (uri) | |
runtime_state |
string | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
aws_volumes_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
size |
integer | Size of volume in gigabytes |
volume_type |
string | Enum: gp2, io1, standard |
device |
string | |
instance |
string (uri) | |
runtime_state |
string | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
aws_volumes_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
Attach
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
AwsVolumeAttachRequest - API Source:
aws_volumes_attach
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
instance |
string (uri) | ✓ | |
device |
string | ✓ | The device name for attachment. For example, use /dev/sd[f-p] for Linux instances. |
200 -
| Field | Type | Description |
|---|---|---|
instance |
string (uri) | |
device |
string | The device name for attachment. For example, use /dev/sd[f-p] for Linux instances. |
Detach
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
aws_volumes_detach
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - No response body
Mark resource as ERRED
Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
SetErredRequest - API Source:
aws_volumes_set_erred
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
error_message |
string | |
error_traceback |
string |
200 -
| Field | Type |
|---|---|
detail |
string |
Mark resource as OK
Manually transition the resource to OK state and clear error fields. Staff-only operation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
aws_volumes_set_ok
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
detail |
string |
Azure
Azure Images
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/azure-images/ |
List Azure Images |
| GET | /api/azure-images/{uuid}/ |
Retrieve |
List Azure Images
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
azure_images_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
location |
string (uri) | |
location_uuid |
string (uuid) | |
name |
string | Name |
name_exact |
string | Name (exact) |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
settings |
string (uri) | Settings URL |
settings_uuid |
string (uuid) | Settings UUID |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
publisher |
string |
name |
string |
sku |
string |
version |
string |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
azure_images_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
publisher |
string |
name |
string |
sku |
string |
version |
string |
Azure Locations
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/azure-locations/ |
List Azure Locations |
| GET | /api/azure-locations/{uuid}/ |
Retrieve |
List Azure Locations
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
azure_locations_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
has_sizes |
boolean | |
name |
string | Name |
name_exact |
string | Name (exact) |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
settings |
string (uri) | Settings URL |
settings_uuid |
string (uuid) | Settings UUID |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
latitude |
number (double) |
longitude |
number (double) |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
azure_locations_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
latitude |
number (double) |
longitude |
number (double) |
Azure Public Ips
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/azure-public-ips/ |
List Azure Public Ips |
| GET | /api/azure-public-ips/{uuid}/ |
Retrieve |
| POST | /api/azure-public-ips/ |
Create |
| POST | /api/azure-public-ips/{uuid}/pull/ |
Synchronize resource state |
| POST | /api/azure-public-ips/{uuid}/unlink/ |
Unlink resource |
| PUT | /api/azure-public-ips/{uuid}/ |
Update |
| PATCH | /api/azure-public-ips/{uuid}/ |
Partial Update |
| DELETE | /api/azure-public-ips/{uuid}/ |
Delete |
| Other Actions | ||
| POST | /api/azure-public-ips/{uuid}/set_erred/ |
Mark resource as ERRED |
| POST | /api/azure-public-ips/{uuid}/set_ok/ |
Mark resource as OK |
Core CRUD
List Azure Public Ips
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- Model Source:
AzurePublicIPFieldEnum - Model Source:
CoreStates - API Source:
azure_public_ips_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
backend_id |
string | Backend ID |
can_manage |
boolean | Can manage |
customer |
string (uuid) | Customer UUID |
customer_abbreviation |
string | Customer abbreviation |
customer_name |
string | Customer name |
customer_native_name |
string | Customer native name |
customer_uuid |
string (uuid) | Customer UUID |
description |
string | Description |
external_ip |
string | External IP |
field |
array | |
name |
string | Name |
name_exact |
string | Name (exact) |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
project |
string (uuid) | Project UUID |
project_name |
string | Project name |
project_uuid |
string (uuid) | Project UUID |
resource_group |
string (uri) | |
resource_group_uuid |
string (uuid) | |
service_settings_name |
string | Service settings name |
service_settings_uuid |
string (uuid) | Service settings UUID |
state |
array | State |
uuid |
string (uuid) | UUID |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
description |
string |
service_name |
string |
service_settings |
string (uri) |
service_settings_uuid |
string (uuid) |
service_settings_state |
string |
service_settings_error_message |
string |
project |
string (uri) |
project_name |
string |
project_uuid |
string (uuid) |
customer |
string (uri) |
customer_uuid |
string (uuid) |
customer_name |
string |
customer_native_name |
string |
customer_abbreviation |
string |
error_message |
string |
error_traceback |
string |
resource_type |
string |
state |
any |
created |
string (date-time) |
modified |
string (date-time) |
backend_id |
string |
access_url |
string |
location |
string (uri) |
resource_group |
string (uri) |
marketplace_offering_uuid |
string |
marketplace_offering_name |
string |
marketplace_offering_plugin_options |
object (free-form) |
marketplace_category_uuid |
string |
marketplace_category_name |
string |
marketplace_resource_uuid |
string |
marketplace_plan_uuid |
string |
marketplace_resource_state |
string |
is_usage_based |
boolean |
is_limit_based |
boolean |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
AzurePublicIPFieldEnum - API Source:
azure_public_ips_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
description |
string |
service_name |
string |
service_settings |
string (uri) |
service_settings_uuid |
string (uuid) |
service_settings_state |
string |
service_settings_error_message |
string |
project |
string (uri) |
project_name |
string |
project_uuid |
string (uuid) |
customer |
string (uri) |
customer_uuid |
string (uuid) |
customer_name |
string |
customer_native_name |
string |
customer_abbreviation |
string |
error_message |
string |
error_traceback |
string |
resource_type |
string |
state |
any |
created |
string (date-time) |
modified |
string (date-time) |
backend_id |
string |
access_url |
string |
location |
string (uri) |
resource_group |
string (uri) |
marketplace_offering_uuid |
string |
marketplace_offering_name |
string |
marketplace_offering_plugin_options |
object (free-form) |
marketplace_category_uuid |
string |
marketplace_category_name |
string |
marketplace_resource_uuid |
string |
marketplace_plan_uuid |
string |
marketplace_resource_state |
string |
is_usage_based |
boolean |
is_limit_based |
boolean |
Create
1 2 3 4 5 6 7 8 9 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 | |
- Model Source:
AzurePublicIPRequest - API Source:
azure_public_ips_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Field | Type | Required |
|---|---|---|
name |
string | ✓ |
description |
string | |
service_settings |
string (uri) | ✓ |
project |
string (uri) | ✓ |
location |
string (uri) | ✓ |
resource_group |
string (uri) | ✓ |
201 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
description |
string |
service_name |
string |
service_settings |
string (uri) |
service_settings_uuid |
string (uuid) |
service_settings_state |
string |
service_settings_error_message |
string |
project |
string (uri) |
project_name |
string |
project_uuid |
string (uuid) |
customer |
string (uri) |
customer_uuid |
string (uuid) |
customer_name |
string |
customer_native_name |
string |
customer_abbreviation |
string |
error_message |
string |
error_traceback |
string |
resource_type |
string |
state |
any |
created |
string (date-time) |
modified |
string (date-time) |
backend_id |
string |
access_url |
string |
location |
string (uri) |
resource_group |
string (uri) |
marketplace_offering_uuid |
string |
marketplace_offering_name |
string |
marketplace_offering_plugin_options |
object (free-form) |
marketplace_category_uuid |
string |
marketplace_category_name |
string |
marketplace_resource_uuid |
string |
marketplace_plan_uuid |
string |
marketplace_resource_state |
string |
is_usage_based |
boolean |
is_limit_based |
boolean |
Synchronize resource state
Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
azure_public_ips_pull
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
202 -
| Field | Type |
|---|---|
detail |
string |
409 -
| Field | Type |
|---|---|
detail |
string |
Unlink resource
Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
azure_public_ips_unlink
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Update
1 2 3 4 5 6 7 8 9 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 | |
- Model Source:
AzurePublicIPRequest - API Source:
azure_public_ips_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
name |
string | ✓ |
description |
string | |
service_settings |
string (uri) | ✓ |
project |
string (uri) | ✓ |
location |
string (uri) | ✓ |
resource_group |
string (uri) | ✓ |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
description |
string |
service_name |
string |
service_settings |
string (uri) |
service_settings_uuid |
string (uuid) |
service_settings_state |
string |
service_settings_error_message |
string |
project |
string (uri) |
project_name |
string |
project_uuid |
string (uuid) |
customer |
string (uri) |
customer_uuid |
string (uuid) |
customer_name |
string |
customer_native_name |
string |
customer_abbreviation |
string |
error_message |
string |
error_traceback |
string |
resource_type |
string |
state |
any |
created |
string (date-time) |
modified |
string (date-time) |
backend_id |
string |
access_url |
string |
location |
string (uri) |
resource_group |
string (uri) |
marketplace_offering_uuid |
string |
marketplace_offering_name |
string |
marketplace_offering_plugin_options |
object (free-form) |
marketplace_category_uuid |
string |
marketplace_category_name |
string |
marketplace_resource_uuid |
string |
marketplace_plan_uuid |
string |
marketplace_resource_state |
string |
is_usage_based |
boolean |
is_limit_based |
boolean |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedAzurePublicIPRequest - API Source:
azure_public_ips_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
description |
string | |
location |
string (uri) | |
resource_group |
string (uri) |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
description |
string |
service_name |
string |
service_settings |
string (uri) |
service_settings_uuid |
string (uuid) |
service_settings_state |
string |
service_settings_error_message |
string |
project |
string (uri) |
project_name |
string |
project_uuid |
string (uuid) |
customer |
string (uri) |
customer_uuid |
string (uuid) |
customer_name |
string |
customer_native_name |
string |
customer_abbreviation |
string |
error_message |
string |
error_traceback |
string |
resource_type |
string |
state |
any |
created |
string (date-time) |
modified |
string (date-time) |
backend_id |
string |
access_url |
string |
location |
string (uri) |
resource_group |
string (uri) |
marketplace_offering_uuid |
string |
marketplace_offering_name |
string |
marketplace_offering_plugin_options |
object (free-form) |
marketplace_category_uuid |
string |
marketplace_category_name |
string |
marketplace_resource_uuid |
string |
marketplace_plan_uuid |
string |
marketplace_resource_state |
string |
is_usage_based |
boolean |
is_limit_based |
boolean |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
azure_public_ips_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
Mark resource as ERRED
Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
SetErredRequest - API Source:
azure_public_ips_set_erred
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
error_message |
string | |
error_traceback |
string |
200 -
| Field | Type |
|---|---|
detail |
string |
Mark resource as OK
Manually transition the resource to OK state and clear error fields. Staff-only operation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
azure_public_ips_set_ok
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
detail |
string |
Azure Resource Groups
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/azure-resource-groups/ |
List Azure Resource Groups |
| GET | /api/azure-resource-groups/{uuid}/ |
Retrieve |
List Azure Resource Groups
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 | |
- Model Source:
AzureResourceGroupFieldEnum - API Source:
azure_resource_groups_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
field |
array | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
description |
string |
service_name |
string |
service_settings |
string (uri) |
service_settings_uuid |
string (uuid) |
service_settings_state |
string |
service_settings_error_message |
string |
project |
string (uri) |
project_name |
string |
project_uuid |
string (uuid) |
customer |
string (uri) |
customer_uuid |
string (uuid) |
customer_name |
string |
customer_native_name |
string |
customer_abbreviation |
string |
error_message |
string |
error_traceback |
string |
resource_type |
string |
state |
any |
created |
string (date-time) |
modified |
string (date-time) |
backend_id |
string |
access_url |
string |
location |
string (uri) |
marketplace_offering_uuid |
string |
marketplace_offering_name |
string |
marketplace_offering_plugin_options |
object (free-form) |
marketplace_category_uuid |
string |
marketplace_category_name |
string |
marketplace_resource_uuid |
string |
marketplace_plan_uuid |
string |
marketplace_resource_state |
string |
is_usage_based |
boolean |
is_limit_based |
boolean |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
AzureResourceGroupFieldEnum - API Source:
azure_resource_groups_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
description |
string |
service_name |
string |
service_settings |
string (uri) |
service_settings_uuid |
string (uuid) |
service_settings_state |
string |
service_settings_error_message |
string |
project |
string (uri) |
project_name |
string |
project_uuid |
string (uuid) |
customer |
string (uri) |
customer_uuid |
string (uuid) |
customer_name |
string |
customer_native_name |
string |
customer_abbreviation |
string |
error_message |
string |
error_traceback |
string |
resource_type |
string |
state |
any |
created |
string (date-time) |
modified |
string (date-time) |
backend_id |
string |
access_url |
string |
location |
string (uri) |
marketplace_offering_uuid |
string |
marketplace_offering_name |
string |
marketplace_offering_plugin_options |
object (free-form) |
marketplace_category_uuid |
string |
marketplace_category_name |
string |
marketplace_resource_uuid |
string |
marketplace_plan_uuid |
string |
marketplace_resource_state |
string |
is_usage_based |
boolean |
is_limit_based |
boolean |
Azure Sizes
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/azure-sizes/ |
List Azure Sizes |
| GET | /api/azure-sizes/{uuid}/ |
Retrieve |
List Azure Sizes
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
azure_sizes_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
location |
string (uri) | |
location_uuid |
string (uuid) | |
name |
string | Name |
name_exact |
string | Name (exact) |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
settings |
string (uri) | Settings URL |
settings_uuid |
string (uuid) | Settings UUID |
zone |
integer |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
max_data_disk_count |
integer |
memory_in_mb |
integer |
number_of_cores |
integer |
os_disk_size_in_mb |
integer |
resource_disk_size_in_mb |
integer |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
azure_sizes_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
max_data_disk_count |
integer |
memory_in_mb |
integer |
number_of_cores |
integer |
os_disk_size_in_mb |
integer |
resource_disk_size_in_mb |
integer |
Azure Sql Databases
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/azure-sql-databases/ |
List Azure Sql Databases |
| GET | /api/azure-sql-databases/{uuid}/ |
Retrieve |
| POST | /api/azure-sql-databases/ |
Create |
| POST | /api/azure-sql-databases/{uuid}/pull/ |
Synchronize resource state |
| POST | /api/azure-sql-databases/{uuid}/unlink/ |
Unlink resource |
| PUT | /api/azure-sql-databases/{uuid}/ |
Update |
| PATCH | /api/azure-sql-databases/{uuid}/ |
Partial Update |
| DELETE | /api/azure-sql-databases/{uuid}/ |
Delete |
| Other Actions | ||
| POST | /api/azure-sql-databases/{uuid}/set_erred/ |
Mark resource as ERRED |
| POST | /api/azure-sql-databases/{uuid}/set_ok/ |
Mark resource as OK |
Core CRUD
List Azure Sql Databases
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- Model Source:
AzureSqlDatabaseFieldEnum - Model Source:
CoreStates - API Source:
azure_sql_databases_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
backend_id |
string | Backend ID |
can_manage |
boolean | Can manage |
customer |
string (uuid) | Customer UUID |
customer_abbreviation |
string | Customer abbreviation |
customer_name |
string | Customer name |
customer_native_name |
string | Customer native name |
customer_uuid |
string (uuid) | Customer UUID |
description |
string | Description |
external_ip |
string | External IP |
field |
array | |
name |
string | Name |
name_exact |
string | Name (exact) |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
project |
string (uuid) | Project UUID |
project_name |
string | Project name |
project_uuid |
string (uuid) | Project UUID |
resource_group |
string (uri) | |
resource_group_uuid |
string (uuid) | |
server |
string (uri) | |
server_uuid |
string (uuid) | |
service_settings_name |
string | Service settings name |
service_settings_uuid |
string (uuid) | Service settings UUID |
state |
array | State |
uuid |
string (uuid) | UUID |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
description |
string |
service_name |
string |
service_settings |
string (uri) |
service_settings_uuid |
string (uuid) |
service_settings_state |
string |
service_settings_error_message |
string |
project |
string (uri) |
project_name |
string |
project_uuid |
string (uuid) |
customer |
string (uri) |
customer_uuid |
string (uuid) |
customer_name |
string |
customer_native_name |
string |
customer_abbreviation |
string |
error_message |
string |
error_traceback |
string |
resource_type |
string |
state |
any |
created |
string (date-time) |
modified |
string (date-time) |
backend_id |
string |
access_url |
string |
server |
string (uri) |
charset |
string |
collation |
string |
resource_group_name |
string |
location_name |
string |
server_name |
string |
server_uuid |
string (uuid) |
server_marketplace_uuid |
string (uuid) |
marketplace_offering_uuid |
string |
marketplace_offering_name |
string |
marketplace_offering_plugin_options |
object (free-form) |
marketplace_category_uuid |
string |
marketplace_category_name |
string |
marketplace_resource_uuid |
string |
marketplace_plan_uuid |
string |
marketplace_resource_state |
string |
is_usage_based |
boolean |
is_limit_based |
boolean |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
AzureSqlDatabaseFieldEnum - API Source:
azure_sql_databases_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
description |
string |
service_name |
string |
service_settings |
string (uri) |
service_settings_uuid |
string (uuid) |
service_settings_state |
string |
service_settings_error_message |
string |
project |
string (uri) |
project_name |
string |
project_uuid |
string (uuid) |
customer |
string (uri) |
customer_uuid |
string (uuid) |
customer_name |
string |
customer_native_name |
string |
customer_abbreviation |
string |
error_message |
string |
error_traceback |
string |
resource_type |
string |
state |
any |
created |
string (date-time) |
modified |
string (date-time) |
backend_id |
string |
access_url |
string |
server |
string (uri) |
charset |
string |
collation |
string |
resource_group_name |
string |
location_name |
string |
server_name |
string |
server_uuid |
string (uuid) |
server_marketplace_uuid |
string (uuid) |
marketplace_offering_uuid |
string |
marketplace_offering_name |
string |
marketplace_offering_plugin_options |
object (free-form) |
marketplace_category_uuid |
string |
marketplace_category_name |
string |
marketplace_resource_uuid |
string |
marketplace_plan_uuid |
string |
marketplace_resource_state |
string |
is_usage_based |
boolean |
is_limit_based |
boolean |
Create
1 2 3 4 5 6 7 8 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | |
- Model Source:
AzureSqlDatabaseRequest - API Source:
azure_sql_databases_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Field | Type | Required |
|---|---|---|
name |
string | ✓ |
description |
string | |
service_settings |
string (uri) | ✓ |
project |
string (uri) | ✓ |
server |
string (uri) | ✓ |
charset |
string | |
collation |
string |
201 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
description |
string |
service_name |
string |
service_settings |
string (uri) |
service_settings_uuid |
string (uuid) |
service_settings_state |
string |
service_settings_error_message |
string |
project |
string (uri) |
project_name |
string |
project_uuid |
string (uuid) |
customer |
string (uri) |
customer_uuid |
string (uuid) |
customer_name |
string |
customer_native_name |
string |
customer_abbreviation |
string |
error_message |
string |
error_traceback |
string |
resource_type |
string |
state |
any |
created |
string (date-time) |
modified |
string (date-time) |
backend_id |
string |
access_url |
string |
server |
string (uri) |
charset |
string |
collation |
string |
resource_group_name |
string |
location_name |
string |
server_name |
string |
server_uuid |
string (uuid) |
server_marketplace_uuid |
string (uuid) |
marketplace_offering_uuid |
string |
marketplace_offering_name |
string |
marketplace_offering_plugin_options |
object (free-form) |
marketplace_category_uuid |
string |
marketplace_category_name |
string |
marketplace_resource_uuid |
string |
marketplace_plan_uuid |
string |
marketplace_resource_state |
string |
is_usage_based |
boolean |
is_limit_based |
boolean |
Synchronize resource state
Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
azure_sql_databases_pull
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
202 -
| Field | Type |
|---|---|
detail |
string |
409 -
| Field | Type |
|---|---|
detail |
string |
Unlink resource
Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
azure_sql_databases_unlink
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Update
1 2 3 4 5 6 7 8 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 | |
- Model Source:
AzureSqlDatabaseRequest - API Source:
azure_sql_databases_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
name |
string | ✓ |
description |
string | |
service_settings |
string (uri) | ✓ |
project |
string (uri) | ✓ |
server |
string (uri) | ✓ |
charset |
string | |
collation |
string |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
description |
string |
service_name |
string |
service_settings |
string (uri) |
service_settings_uuid |
string (uuid) |
service_settings_state |
string |
service_settings_error_message |
string |
project |
string (uri) |
project_name |
string |
project_uuid |
string (uuid) |
customer |
string (uri) |
customer_uuid |
string (uuid) |
customer_name |
string |
customer_native_name |
string |
customer_abbreviation |
string |
error_message |
string |
error_traceback |
string |
resource_type |
string |
state |
any |
created |
string (date-time) |
modified |
string (date-time) |
backend_id |
string |
access_url |
string |
server |
string (uri) |
charset |
string |
collation |
string |
resource_group_name |
string |
location_name |
string |
server_name |
string |
server_uuid |
string (uuid) |
server_marketplace_uuid |
string (uuid) |
marketplace_offering_uuid |
string |
marketplace_offering_name |
string |
marketplace_offering_plugin_options |
object (free-form) |
marketplace_category_uuid |
string |
marketplace_category_name |
string |
marketplace_resource_uuid |
string |
marketplace_plan_uuid |
string |
marketplace_resource_state |
string |
is_usage_based |
boolean |
is_limit_based |
boolean |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedAzureSqlDatabaseRequest - API Source:
azure_sql_databases_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
description |
string | |
server |
string (uri) | |
charset |
string | |
collation |
string |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
description |
string |
service_name |
string |
service_settings |
string (uri) |
service_settings_uuid |
string (uuid) |
service_settings_state |
string |
service_settings_error_message |
string |
project |
string (uri) |
project_name |
string |
project_uuid |
string (uuid) |
customer |
string (uri) |
customer_uuid |
string (uuid) |
customer_name |
string |
customer_native_name |
string |
customer_abbreviation |
string |
error_message |
string |
error_traceback |
string |
resource_type |
string |
state |
any |
created |
string (date-time) |
modified |
string (date-time) |
backend_id |
string |
access_url |
string |
server |
string (uri) |
charset |
string |
collation |
string |
resource_group_name |
string |
location_name |
string |
server_name |
string |
server_uuid |
string (uuid) |
server_marketplace_uuid |
string (uuid) |
marketplace_offering_uuid |
string |
marketplace_offering_name |
string |
marketplace_offering_plugin_options |
object (free-form) |
marketplace_category_uuid |
string |
marketplace_category_name |
string |
marketplace_resource_uuid |
string |
marketplace_plan_uuid |
string |
marketplace_resource_state |
string |
is_usage_based |
boolean |
is_limit_based |
boolean |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
azure_sql_databases_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
Mark resource as ERRED
Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
SetErredRequest - API Source:
azure_sql_databases_set_erred
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
error_message |
string | |
error_traceback |
string |
200 -
| Field | Type |
|---|---|
detail |
string |
Mark resource as OK
Manually transition the resource to OK state and clear error fields. Staff-only operation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
azure_sql_databases_set_ok
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
detail |
string |
Azure Sql Servers
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/azure-sql-servers/ |
List Azure Sql Servers |
| GET | /api/azure-sql-servers/{uuid}/ |
Retrieve |
| POST | /api/azure-sql-servers/ |
Create |
| POST | /api/azure-sql-servers/{uuid}/create_database/ |
Create database |
| POST | /api/azure-sql-servers/{uuid}/pull/ |
Synchronize resource state |
| POST | /api/azure-sql-servers/{uuid}/unlink/ |
Unlink resource |
| PUT | /api/azure-sql-servers/{uuid}/ |
Update |
| PATCH | /api/azure-sql-servers/{uuid}/ |
Partial Update |
| DELETE | /api/azure-sql-servers/{uuid}/ |
Delete |
| Other Actions | ||
| POST | /api/azure-sql-servers/{uuid}/set_erred/ |
Mark resource as ERRED |
| POST | /api/azure-sql-servers/{uuid}/set_ok/ |
Mark resource as OK |
Core CRUD
List Azure Sql Servers
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- Model Source:
AzureSqlServerFieldEnum - Model Source:
CoreStates - API Source:
azure_sql_servers_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
backend_id |
string | Backend ID |
can_manage |
boolean | Can manage |
customer |
string (uuid) | Customer UUID |
customer_abbreviation |
string | Customer abbreviation |
customer_name |
string | Customer name |
customer_native_name |
string | Customer native name |
customer_uuid |
string (uuid) | Customer UUID |
description |
string | Description |
external_ip |
string | External IP |
field |
array | |
name |
string | Name |
name_exact |
string | Name (exact) |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
project |
string (uuid) | Project UUID |
project_name |
string | Project name |
project_uuid |
string (uuid) | Project UUID |
resource_group |
string (uri) | |
resource_group_uuid |
string (uuid) | |
service_settings_name |
string | Service settings name |
service_settings_uuid |
string (uuid) | Service settings UUID |
state |
array | State |
uuid |
string (uuid) | UUID |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
description |
string |
service_name |
string |
service_settings |
string (uri) |
service_settings_uuid |
string (uuid) |
service_settings_state |
string |
service_settings_error_message |
string |
project |
string (uri) |
project_name |
string |
project_uuid |
string (uuid) |
customer |
string (uri) |
customer_uuid |
string (uuid) |
customer_name |
string |
customer_native_name |
string |
customer_abbreviation |
string |
error_message |
string |
error_traceback |
string |
resource_type |
string |
state |
any |
created |
string (date-time) |
modified |
string (date-time) |
backend_id |
string |
access_url |
string |
resource_group |
string (uri) |
username |
string |
password |
string |
storage_mb |
integer |
fqdn |
string |
resource_group_name |
string |
location_name |
string |
marketplace_offering_uuid |
string |
marketplace_offering_name |
string |
marketplace_offering_plugin_options |
object (free-form) |
marketplace_category_uuid |
string |
marketplace_category_name |
string |
marketplace_resource_uuid |
string |
marketplace_plan_uuid |
string |
marketplace_resource_state |
string |
is_usage_based |
boolean |
is_limit_based |
boolean |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
AzureSqlServerFieldEnum - API Source:
azure_sql_servers_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
description |
string |
service_name |
string |
service_settings |
string (uri) |
service_settings_uuid |
string (uuid) |
service_settings_state |
string |
service_settings_error_message |
string |
project |
string (uri) |
project_name |
string |
project_uuid |
string (uuid) |
customer |
string (uri) |
customer_uuid |
string (uuid) |
customer_name |
string |
customer_native_name |
string |
customer_abbreviation |
string |
error_message |
string |
error_traceback |
string |
resource_type |
string |
state |
any |
created |
string (date-time) |
modified |
string (date-time) |
backend_id |
string |
access_url |
string |
resource_group |
string (uri) |
username |
string |
password |
string |
storage_mb |
integer |
fqdn |
string |
resource_group_name |
string |
location_name |
string |
marketplace_offering_uuid |
string |
marketplace_offering_name |
string |
marketplace_offering_plugin_options |
object (free-form) |
marketplace_category_uuid |
string |
marketplace_category_name |
string |
marketplace_resource_uuid |
string |
marketplace_plan_uuid |
string |
marketplace_resource_state |
string |
is_usage_based |
boolean |
is_limit_based |
boolean |
Create
1 2 3 4 5 6 7 8 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | |
- Model Source:
AzureSqlServerRequest - API Source:
azure_sql_servers_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Field | Type | Required |
|---|---|---|
name |
string | ✓ |
description |
string | |
service_settings |
string (uri) | ✓ |
project |
string (uri) | ✓ |
location |
string (uri) | ✓ |
storage_mb |
integer |
201 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
description |
string |
service_name |
string |
service_settings |
string (uri) |
service_settings_uuid |
string (uuid) |
service_settings_state |
string |
service_settings_error_message |
string |
project |
string (uri) |
project_name |
string |
project_uuid |
string (uuid) |
customer |
string (uri) |
customer_uuid |
string (uuid) |
customer_name |
string |
customer_native_name |
string |
customer_abbreviation |
string |
error_message |
string |
error_traceback |
string |
resource_type |
string |
state |
any |
created |
string (date-time) |
modified |
string (date-time) |
backend_id |
string |
access_url |
string |
resource_group |
string (uri) |
username |
string |
password |
string |
storage_mb |
integer |
fqdn |
string |
resource_group_name |
string |
location_name |
string |
marketplace_offering_uuid |
string |
marketplace_offering_name |
string |
marketplace_offering_plugin_options |
object (free-form) |
marketplace_category_uuid |
string |
marketplace_category_name |
string |
marketplace_resource_uuid |
string |
marketplace_plan_uuid |
string |
marketplace_resource_state |
string |
is_usage_based |
boolean |
is_limit_based |
boolean |
Create database
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
AzureSqlDatabaseCreateRequest - API Source:
azure_sql_servers_create_database
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
name |
string | ✓ |
description |
string |
200 -
| Field | Type |
|---|---|
name |
string |
description |
string |
Synchronize resource state
Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
azure_sql_servers_pull
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
202 -
| Field | Type |
|---|---|
detail |
string |
409 -
| Field | Type |
|---|---|
detail |
string |
Unlink resource
Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
azure_sql_servers_unlink
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Update
1 2 3 4 5 6 7 8 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 | |
- Model Source:
AzureSqlServerRequest - API Source:
azure_sql_servers_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
name |
string | ✓ |
description |
string | |
service_settings |
string (uri) | ✓ |
project |
string (uri) | ✓ |
location |
string (uri) | ✓ |
storage_mb |
integer |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
description |
string |
service_name |
string |
service_settings |
string (uri) |
service_settings_uuid |
string (uuid) |
service_settings_state |
string |
service_settings_error_message |
string |
project |
string (uri) |
project_name |
string |
project_uuid |
string (uuid) |
customer |
string (uri) |
customer_uuid |
string (uuid) |
customer_name |
string |
customer_native_name |
string |
customer_abbreviation |
string |
error_message |
string |
error_traceback |
string |
resource_type |
string |
state |
any |
created |
string (date-time) |
modified |
string (date-time) |
backend_id |
string |
access_url |
string |
resource_group |
string (uri) |
username |
string |
password |
string |
storage_mb |
integer |
fqdn |
string |
resource_group_name |
string |
location_name |
string |
marketplace_offering_uuid |
string |
marketplace_offering_name |
string |
marketplace_offering_plugin_options |
object (free-form) |
marketplace_category_uuid |
string |
marketplace_category_name |
string |
marketplace_resource_uuid |
string |
marketplace_plan_uuid |
string |
marketplace_resource_state |
string |
is_usage_based |
boolean |
is_limit_based |
boolean |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedAzureSqlServerRequest - API Source:
azure_sql_servers_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
description |
string | |
location |
string (uri) | |
storage_mb |
integer |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
description |
string |
service_name |
string |
service_settings |
string (uri) |
service_settings_uuid |
string (uuid) |
service_settings_state |
string |
service_settings_error_message |
string |
project |
string (uri) |
project_name |
string |
project_uuid |
string (uuid) |
customer |
string (uri) |
customer_uuid |
string (uuid) |
customer_name |
string |
customer_native_name |
string |
customer_abbreviation |
string |
error_message |
string |
error_traceback |
string |
resource_type |
string |
state |
any |
created |
string (date-time) |
modified |
string (date-time) |
backend_id |
string |
access_url |
string |
resource_group |
string (uri) |
username |
string |
password |
string |
storage_mb |
integer |
fqdn |
string |
resource_group_name |
string |
location_name |
string |
marketplace_offering_uuid |
string |
marketplace_offering_name |
string |
marketplace_offering_plugin_options |
object (free-form) |
marketplace_category_uuid |
string |
marketplace_category_name |
string |
marketplace_resource_uuid |
string |
marketplace_plan_uuid |
string |
marketplace_resource_state |
string |
is_usage_based |
boolean |
is_limit_based |
boolean |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
azure_sql_servers_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
Mark resource as ERRED
Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
SetErredRequest - API Source:
azure_sql_servers_set_erred
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
error_message |
string | |
error_traceback |
string |
200 -
| Field | Type |
|---|---|
detail |
string |
Mark resource as OK
Manually transition the resource to OK state and clear error fields. Staff-only operation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
azure_sql_servers_set_ok
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
detail |
string |
Azure Virtualmachines
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/azure-virtualmachines/ |
List Azure Virtualmachines |
| GET | /api/azure-virtualmachines/{uuid}/ |
Retrieve |
| POST | /api/azure-virtualmachines/ |
Create |
| POST | /api/azure-virtualmachines/{uuid}/pull/ |
Synchronize resource state |
| POST | /api/azure-virtualmachines/{uuid}/unlink/ |
Unlink resource |
| PUT | /api/azure-virtualmachines/{uuid}/ |
Update |
| PATCH | /api/azure-virtualmachines/{uuid}/ |
Partial Update |
| DELETE | /api/azure-virtualmachines/{uuid}/ |
Delete |
| Other Actions | ||
| POST | /api/azure-virtualmachines/{uuid}/restart/ |
Restart |
| POST | /api/azure-virtualmachines/{uuid}/set_erred/ |
Mark resource as ERRED |
| POST | /api/azure-virtualmachines/{uuid}/set_ok/ |
Mark resource as OK |
| POST | /api/azure-virtualmachines/{uuid}/start/ |
Start |
| POST | /api/azure-virtualmachines/{uuid}/stop/ |
Stop |
Core CRUD
List Azure Virtualmachines
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- Model Source:
AzureVirtualMachineFieldEnum - Model Source:
CoreStates - API Source:
azure_virtualmachines_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
backend_id |
string | Backend ID |
can_manage |
boolean | Can manage |
customer |
string (uuid) | Customer UUID |
customer_abbreviation |
string | Customer abbreviation |
customer_name |
string | Customer name |
customer_native_name |
string | Customer native name |
customer_uuid |
string (uuid) | Customer UUID |
description |
string | Description |
external_ip |
string | External IP |
field |
array | |
name |
string | Name |
name_exact |
string | Name (exact) |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
project |
string (uuid) | Project UUID |
project_name |
string | Project name |
project_uuid |
string (uuid) | Project UUID |
resource_group |
string (uri) | |
resource_group_uuid |
string (uuid) | |
service_settings_name |
string | Service settings name |
service_settings_uuid |
string (uuid) | Service settings UUID |
state |
array | State |
uuid |
string (uuid) | UUID |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
start_time |
string (date-time) | |
cores |
integer | Number of cores in a VM |
ram |
integer | Memory size in MiB |
disk |
integer | Disk size in MiB |
min_ram |
integer | Minimum memory size in MiB |
min_disk |
integer | Minimum disk size in MiB |
user_data |
string | Additional data that will be added to instance on provisioning |
external_ips |
array of string (ipv4)s | |
internal_ips |
array of string (ipv4)s | |
latitude |
number (double) | |
longitude |
number (double) | |
key_name |
string | |
key_fingerprint |
string | |
image_name |
string | |
image |
string (uri) | |
size |
string (uri) | |
runtime_state |
string | |
resource_group |
string (uri) | |
username |
string | |
password |
string | |
resource_group_name |
string | |
location_name |
string | |
size_name |
string | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
AzureVirtualMachineFieldEnum - API Source:
azure_virtualmachines_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
start_time |
string (date-time) | |
cores |
integer | Number of cores in a VM |
ram |
integer | Memory size in MiB |
disk |
integer | Disk size in MiB |
min_ram |
integer | Minimum memory size in MiB |
min_disk |
integer | Minimum disk size in MiB |
user_data |
string | Additional data that will be added to instance on provisioning |
external_ips |
array of string (ipv4)s | |
internal_ips |
array of string (ipv4)s | |
latitude |
number (double) | |
longitude |
number (double) | |
key_name |
string | |
key_fingerprint |
string | |
image_name |
string | |
image |
string (uri) | |
size |
string (uri) | |
runtime_state |
string | |
resource_group |
string (uri) | |
username |
string | |
password |
string | |
resource_group_name |
string | |
location_name |
string | |
size_name |
string | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Create
1 2 3 4 5 6 7 8 9 10 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 | |
- Model Source:
AzureVirtualMachineRequest - API Source:
azure_virtualmachines_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ✓ | |
description |
string | ||
service_settings |
string (uri) | ✓ | |
project |
string (uri) | ✓ | |
ssh_public_key |
string (uri) | Constraints: write-only |
|
user_data |
string | Additional data that will be added to instance on provisioning | |
image |
string (uri) | ✓ | |
size |
string (uri) | ✓ | |
location |
string (uri) | ✓ | Constraints: write-only |
201 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
start_time |
string (date-time) | |
cores |
integer | Number of cores in a VM |
ram |
integer | Memory size in MiB |
disk |
integer | Disk size in MiB |
min_ram |
integer | Minimum memory size in MiB |
min_disk |
integer | Minimum disk size in MiB |
user_data |
string | Additional data that will be added to instance on provisioning |
external_ips |
array of string (ipv4)s | |
internal_ips |
array of string (ipv4)s | |
latitude |
number (double) | |
longitude |
number (double) | |
key_name |
string | |
key_fingerprint |
string | |
image_name |
string | |
image |
string (uri) | |
size |
string (uri) | |
runtime_state |
string | |
resource_group |
string (uri) | |
username |
string | |
password |
string | |
resource_group_name |
string | |
location_name |
string | |
size_name |
string | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Synchronize resource state
Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
azure_virtualmachines_pull
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
202 -
| Field | Type |
|---|---|
detail |
string |
409 -
| Field | Type |
|---|---|
detail |
string |
Unlink resource
Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
azure_virtualmachines_unlink
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Update
1 2 3 4 5 6 7 8 9 10 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 | |
- Model Source:
AzureVirtualMachineRequest - API Source:
azure_virtualmachines_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ✓ | |
description |
string | ||
service_settings |
string (uri) | ✓ | |
project |
string (uri) | ✓ | |
ssh_public_key |
string (uri) | Constraints: write-only |
|
user_data |
string | Additional data that will be added to instance on provisioning | |
image |
string (uri) | ✓ | |
size |
string (uri) | ✓ | |
location |
string (uri) | ✓ | Constraints: write-only |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
start_time |
string (date-time) | |
cores |
integer | Number of cores in a VM |
ram |
integer | Memory size in MiB |
disk |
integer | Disk size in MiB |
min_ram |
integer | Minimum memory size in MiB |
min_disk |
integer | Minimum disk size in MiB |
user_data |
string | Additional data that will be added to instance on provisioning |
external_ips |
array of string (ipv4)s | |
internal_ips |
array of string (ipv4)s | |
latitude |
number (double) | |
longitude |
number (double) | |
key_name |
string | |
key_fingerprint |
string | |
image_name |
string | |
image |
string (uri) | |
size |
string (uri) | |
runtime_state |
string | |
resource_group |
string (uri) | |
username |
string | |
password |
string | |
resource_group_name |
string | |
location_name |
string | |
size_name |
string | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedAzureVirtualMachineRequest - API Source:
azure_virtualmachines_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
description |
string | |
location |
string (uri) |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
start_time |
string (date-time) | |
cores |
integer | Number of cores in a VM |
ram |
integer | Memory size in MiB |
disk |
integer | Disk size in MiB |
min_ram |
integer | Minimum memory size in MiB |
min_disk |
integer | Minimum disk size in MiB |
user_data |
string | Additional data that will be added to instance on provisioning |
external_ips |
array of string (ipv4)s | |
internal_ips |
array of string (ipv4)s | |
latitude |
number (double) | |
longitude |
number (double) | |
key_name |
string | |
key_fingerprint |
string | |
image_name |
string | |
image |
string (uri) | |
size |
string (uri) | |
runtime_state |
string | |
resource_group |
string (uri) | |
username |
string | |
password |
string | |
resource_group_name |
string | |
location_name |
string | |
size_name |
string | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
azure_virtualmachines_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
Restart
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
azure_virtualmachines_restart
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - No response body
Mark resource as ERRED
Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
SetErredRequest - API Source:
azure_virtualmachines_set_erred
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
error_message |
string | |
error_traceback |
string |
200 -
| Field | Type |
|---|---|
detail |
string |
Mark resource as OK
Manually transition the resource to OK state and clear error fields. Staff-only operation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
azure_virtualmachines_set_ok
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
detail |
string |
Start
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
azure_virtualmachines_start
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - No response body
Stop
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
azure_virtualmachines_stop
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - No response body
Digitalocean
Digitalocean Droplets
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/digitalocean-droplets/ |
List Digitalocean Droplets |
| GET | /api/digitalocean-droplets/{uuid}/ |
Retrieve |
| POST | /api/digitalocean-droplets/ |
Create |
| POST | /api/digitalocean-droplets/{uuid}/pull/ |
Synchronize resource state |
| POST | /api/digitalocean-droplets/{uuid}/unlink/ |
Unlink resource |
| PUT | /api/digitalocean-droplets/{uuid}/ |
Update |
| PATCH | /api/digitalocean-droplets/{uuid}/ |
Partial Update |
| DELETE | /api/digitalocean-droplets/{uuid}/ |
Delete |
| Other Actions | ||
| POST | /api/digitalocean-droplets/{uuid}/resize/ |
Resize |
| POST | /api/digitalocean-droplets/{uuid}/restart/ |
Restart |
| POST | /api/digitalocean-droplets/{uuid}/set_erred/ |
Mark resource as ERRED |
| POST | /api/digitalocean-droplets/{uuid}/set_ok/ |
Mark resource as OK |
| POST | /api/digitalocean-droplets/{uuid}/start/ |
Start |
| POST | /api/digitalocean-droplets/{uuid}/stop/ |
Stop |
Core CRUD
List Digitalocean Droplets
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- Model Source:
CoreStates - Model Source:
DigitalOceanDropletFieldEnum - API Source:
digitalocean_droplets_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
backend_id |
string | Backend ID |
can_manage |
boolean | Can manage |
customer |
string (uuid) | Customer UUID |
customer_abbreviation |
string | Customer abbreviation |
customer_name |
string | Customer name |
customer_native_name |
string | Customer native name |
customer_uuid |
string (uuid) | Customer UUID |
description |
string | Description |
external_ip |
string | |
field |
array | |
name |
string | Name |
name_exact |
string | Name (exact) |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
project |
string (uuid) | Project UUID |
project_name |
string | Project name |
project_uuid |
string (uuid) | Project UUID |
service_settings_name |
string | Service settings name |
service_settings_uuid |
string (uuid) | Service settings UUID |
state |
array | State |
uuid |
string (uuid) | UUID |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
start_time |
string (date-time) | |
cores |
integer | Number of cores in a VM |
ram |
integer | Memory size in MiB |
disk |
integer | Disk size in MiB |
min_ram |
integer | Minimum memory size in MiB |
min_disk |
integer | Minimum disk size in MiB |
user_data |
string | Additional data that will be added to instance on provisioning |
external_ips |
array of string (ipv4)s | |
internal_ips |
array of string (ipv4)s | |
latitude |
number (double) | |
longitude |
number (double) | |
key_name |
string | |
key_fingerprint |
string | |
image_name |
string | |
runtime_state |
string | |
region_name |
string | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
DigitalOceanDropletFieldEnum - API Source:
digitalocean_droplets_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
start_time |
string (date-time) | |
cores |
integer | Number of cores in a VM |
ram |
integer | Memory size in MiB |
disk |
integer | Disk size in MiB |
min_ram |
integer | Minimum memory size in MiB |
min_disk |
integer | Minimum disk size in MiB |
user_data |
string | Additional data that will be added to instance on provisioning |
external_ips |
array of string (ipv4)s | |
internal_ips |
array of string (ipv4)s | |
latitude |
number (double) | |
longitude |
number (double) | |
key_name |
string | |
key_fingerprint |
string | |
image_name |
string | |
runtime_state |
string | |
region_name |
string | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Create
1 2 3 4 5 6 7 8 9 10 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 | |
- Model Source:
DigitalOceanDropletRequest - API Source:
digitalocean_droplets_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ✓ | |
description |
string | ||
service_settings |
string (uri) | ✓ | |
project |
string (uri) | ✓ | |
ssh_public_key |
string (uri) | Constraints: write-only |
|
user_data |
string | Additional data that will be added to instance on provisioning | |
region |
string (uri) | ✓ | Constraints: write-only |
image |
string (uri) | ✓ | Constraints: write-only |
size |
string (uri) | ✓ | Constraints: write-only |
201 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
start_time |
string (date-time) | |
cores |
integer | Number of cores in a VM |
ram |
integer | Memory size in MiB |
disk |
integer | Disk size in MiB |
min_ram |
integer | Minimum memory size in MiB |
min_disk |
integer | Minimum disk size in MiB |
user_data |
string | Additional data that will be added to instance on provisioning |
external_ips |
array of string (ipv4)s | |
internal_ips |
array of string (ipv4)s | |
latitude |
number (double) | |
longitude |
number (double) | |
key_name |
string | |
key_fingerprint |
string | |
image_name |
string | |
runtime_state |
string | |
region_name |
string | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Synchronize resource state
Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
digitalocean_droplets_pull
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
202 -
| Field | Type |
|---|---|
detail |
string |
409 -
| Field | Type |
|---|---|
detail |
string |
Unlink resource
Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
digitalocean_droplets_unlink
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Update
1 2 3 4 5 6 7 8 9 10 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 | |
- Model Source:
DigitalOceanDropletRequest - API Source:
digitalocean_droplets_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ✓ | |
description |
string | ||
service_settings |
string (uri) | ✓ | |
project |
string (uri) | ✓ | |
ssh_public_key |
string (uri) | Constraints: write-only |
|
user_data |
string | Additional data that will be added to instance on provisioning | |
region |
string (uri) | ✓ | Constraints: write-only |
image |
string (uri) | ✓ | Constraints: write-only |
size |
string (uri) | ✓ | Constraints: write-only |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
start_time |
string (date-time) | |
cores |
integer | Number of cores in a VM |
ram |
integer | Memory size in MiB |
disk |
integer | Disk size in MiB |
min_ram |
integer | Minimum memory size in MiB |
min_disk |
integer | Minimum disk size in MiB |
user_data |
string | Additional data that will be added to instance on provisioning |
external_ips |
array of string (ipv4)s | |
internal_ips |
array of string (ipv4)s | |
latitude |
number (double) | |
longitude |
number (double) | |
key_name |
string | |
key_fingerprint |
string | |
image_name |
string | |
runtime_state |
string | |
region_name |
string | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedDigitalOceanDropletRequest - API Source:
digitalocean_droplets_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
name |
string | |
description |
string |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
start_time |
string (date-time) | |
cores |
integer | Number of cores in a VM |
ram |
integer | Memory size in MiB |
disk |
integer | Disk size in MiB |
min_ram |
integer | Minimum memory size in MiB |
min_disk |
integer | Minimum disk size in MiB |
user_data |
string | Additional data that will be added to instance on provisioning |
external_ips |
array of string (ipv4)s | |
internal_ips |
array of string (ipv4)s | |
latitude |
number (double) | |
longitude |
number (double) | |
key_name |
string | |
key_fingerprint |
string | |
image_name |
string | |
runtime_state |
string | |
region_name |
string | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
digitalocean_droplets_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
Resize
To resize droplet, submit a POST request to the instance URL, specifying URI of a target size.
Pass {'disk': true} along with target size in order to perform permanent resizing, which allows you to resize your disk space as well as CPU and RAM. After increasing the disk size, you will not be able to decrease it.
Pass {'disk': false} along with target size in order to perform flexible resizing, which only upgrades your CPU and RAM. This option is reversible.
Note that instance must be OFFLINE.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
DigitalOceanDropletResizeRequest - API Source:
digitalocean_droplets_resize
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
size |
string (uri) | ✓ |
disk |
boolean | ✓ |
200 -
| Field | Type |
|---|---|
disk |
boolean |
Restart
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
digitalocean_droplets_restart
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - No response body
Mark resource as ERRED
Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
SetErredRequest - API Source:
digitalocean_droplets_set_erred
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
error_message |
string | |
error_traceback |
string |
200 -
| Field | Type |
|---|---|
detail |
string |
Mark resource as OK
Manually transition the resource to OK state and clear error fields. Staff-only operation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
digitalocean_droplets_set_ok
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
detail |
string |
Start
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
digitalocean_droplets_start
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - No response body
Stop
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
digitalocean_droplets_stop
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - No response body
Digitalocean Images
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/digitalocean-images/ |
List Digitalocean Images |
| GET | /api/digitalocean-images/{uuid}/ |
Retrieve |
List Digitalocean Images
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 | |
- Model Source:
DigitalOceanImageOEnum - API Source:
digitalocean_images_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
distribution |
string | |
name |
string | Name |
name_exact |
string | Name (exact) |
o |
array | Ordering |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
type |
string |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
distribution |
string | |
type |
string | |
regions |
array of objects | |
regions.url |
string (uri) | |
regions.uuid |
string (uuid) | |
regions.name |
string | |
is_official |
boolean | Is image provided by DigitalOcean |
created_at |
string (date-time) | |
min_disk_size |
integer | Minimum disk required for a size to use this image |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
digitalocean_images_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
distribution |
string | |
type |
string | |
regions |
array of objects | |
regions.url |
string (uri) | |
regions.uuid |
string (uuid) | |
regions.name |
string | |
is_official |
boolean | Is image provided by DigitalOcean |
created_at |
string (date-time) | |
min_disk_size |
integer | Minimum disk required for a size to use this image |
Digitalocean Regions
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/digitalocean-regions/ |
List Digitalocean Regions |
| GET | /api/digitalocean-regions/{uuid}/ |
Retrieve |
List Digitalocean Regions
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
digitalocean_regions_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
name |
string | Name |
name_exact |
string | Name (exact) |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
digitalocean_regions_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
Digitalocean Sizes
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/digitalocean-sizes/ |
List Digitalocean Sizes |
| GET | /api/digitalocean-sizes/{uuid}/ |
Retrieve |
List Digitalocean Sizes
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
digitalocean_sizes_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
cores |
integer | |
disk |
integer | |
name |
string | Name |
name_exact |
string | Name (exact) |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
ram |
integer |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
cores |
integer | Number of cores in a VM |
ram |
integer | Memory size in MiB |
disk |
integer | Disk size in MiB |
transfer |
integer | Amount of transfer bandwidth in MiB |
regions |
array of objects | |
regions.url |
string (uri) | |
regions.uuid |
string (uuid) | |
regions.name |
string |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
digitalocean_sizes_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
cores |
integer | Number of cores in a VM |
ram |
integer | Memory size in MiB |
disk |
integer | Disk size in MiB |
transfer |
integer | Amount of transfer bandwidth in MiB |
regions |
array of objects | |
regions.url |
string (uri) | |
regions.uuid |
string (uuid) | |
regions.name |
string |
Openportal
Openportal Allocation User Usage
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/openportal-allocation-user-usage/ |
List Openportal Allocation User Usage |
| GET | /api/openportal-allocation-user-usage/{id}/ |
Retrieve |
List Openportal Allocation User Usage
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
openportal_allocation_user_usage_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
allocation |
string (uri) | |
allocation_uuid |
string (uuid) | |
month |
integer | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
user |
string (uri) | |
user_uuid |
string (uuid) | |
year |
integer |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
node_usage |
string (decimal) |
month |
integer |
year |
integer |
allocation |
string (uri) |
user |
string (uri) |
username |
string |
full_name |
string |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openportal_allocation_user_usage_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required | Description |
|---|---|---|---|
id |
integer | ✓ | A unique integer value identifying this allocation user usage. |
200 -
| Field | Type |
|---|---|
node_usage |
string (decimal) |
month |
integer |
year |
integer |
allocation |
string (uri) |
user |
string (uri) |
username |
string |
full_name |
string |
Openportal Allocations
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/openportal-allocations/ |
List Openportal Allocations |
| GET | /api/openportal-allocations/{uuid}/ |
Retrieve |
| POST | /api/openportal-allocations/ |
Create |
| POST | /api/openportal-allocations/{uuid}/pull/ |
Synchronize resource state |
| POST | /api/openportal-allocations/{uuid}/unlink/ |
Unlink resource |
| PUT | /api/openportal-allocations/{uuid}/ |
Update |
| PATCH | /api/openportal-allocations/{uuid}/ |
Partial Update |
| DELETE | /api/openportal-allocations/{uuid}/ |
Delete |
| Other Actions | ||
| POST | /api/openportal-allocations/{uuid}/set_erred/ |
Mark resource as ERRED |
| POST | /api/openportal-allocations/{uuid}/set_limits/ |
Set limits |
| POST | /api/openportal-allocations/{uuid}/set_ok/ |
Mark resource as OK |
Core CRUD
List Openportal Allocations
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- Model Source:
AllocationFieldEnum - Model Source:
CoreStates - API Source:
openportal_allocations_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
backend_id |
string | Backend ID |
can_manage |
boolean | Can manage |
customer |
string (uuid) | Customer UUID |
customer_abbreviation |
string | Customer abbreviation |
customer_name |
string | Customer name |
customer_native_name |
string | Customer native name |
customer_uuid |
string (uuid) | Customer UUID |
description |
string | Description |
external_ip |
string | External IP |
field |
array | |
is_active |
boolean | |
name |
string | Name |
name_exact |
string | Name (exact) |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
project |
string (uuid) | Project UUID |
project_name |
string | Project name |
project_uuid |
string (uuid) | Project UUID |
service_settings_name |
string | Service settings name |
service_settings_uuid |
string (uuid) | Service settings UUID |
state |
array | State |
uuid |
string (uuid) | UUID |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
description |
string |
service_name |
string |
service_settings |
string (uri) |
service_settings_uuid |
string (uuid) |
service_settings_state |
string |
service_settings_error_message |
string |
project |
string (uri) |
project_name |
string |
project_uuid |
string (uuid) |
customer |
string (uri) |
customer_uuid |
string (uuid) |
customer_name |
string |
customer_native_name |
string |
customer_abbreviation |
string |
error_message |
string |
error_traceback |
string |
resource_type |
string |
state |
any |
created |
string (date-time) |
modified |
string (date-time) |
backend_id |
string |
access_url |
string |
node_limit |
integer (int64) |
groupname |
string |
node_usage |
string (decimal) |
is_active |
boolean |
marketplace_offering_uuid |
string |
marketplace_offering_name |
string |
marketplace_offering_plugin_options |
object (free-form) |
marketplace_category_uuid |
string |
marketplace_category_name |
string |
marketplace_resource_uuid |
string |
marketplace_plan_uuid |
string |
marketplace_resource_state |
string |
is_usage_based |
boolean |
is_limit_based |
boolean |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
AllocationFieldEnum - API Source:
openportal_allocations_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
description |
string |
service_name |
string |
service_settings |
string (uri) |
service_settings_uuid |
string (uuid) |
service_settings_state |
string |
service_settings_error_message |
string |
project |
string (uri) |
project_name |
string |
project_uuid |
string (uuid) |
customer |
string (uri) |
customer_uuid |
string (uuid) |
customer_name |
string |
customer_native_name |
string |
customer_abbreviation |
string |
error_message |
string |
error_traceback |
string |
resource_type |
string |
state |
any |
created |
string (date-time) |
modified |
string (date-time) |
backend_id |
string |
access_url |
string |
node_limit |
integer (int64) |
groupname |
string |
node_usage |
string (decimal) |
is_active |
boolean |
marketplace_offering_uuid |
string |
marketplace_offering_name |
string |
marketplace_offering_plugin_options |
object (free-form) |
marketplace_category_uuid |
string |
marketplace_category_name |
string |
marketplace_resource_uuid |
string |
marketplace_plan_uuid |
string |
marketplace_resource_state |
string |
is_usage_based |
boolean |
is_limit_based |
boolean |
Create
1 2 3 4 5 6 7 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
AllocationRequest - API Source:
openportal_allocations_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
| Field | Type | Required |
|---|---|---|
name |
string | ✓ |
description |
string | |
service_settings |
string (uri) | ✓ |
project |
string (uri) | ✓ |
node_limit |
integer (int64) | |
groupname |
string |
201 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
description |
string |
service_name |
string |
service_settings |
string (uri) |
service_settings_uuid |
string (uuid) |
service_settings_state |
string |
service_settings_error_message |
string |
project |
string (uri) |
project_name |
string |
project_uuid |
string (uuid) |
customer |
string (uri) |
customer_uuid |
string (uuid) |
customer_name |
string |
customer_native_name |
string |
customer_abbreviation |
string |
error_message |
string |
error_traceback |
string |
resource_type |
string |
state |
any |
created |
string (date-time) |
modified |
string (date-time) |
backend_id |
string |
access_url |
string |
node_limit |
integer (int64) |
groupname |
string |
node_usage |
string (decimal) |
is_active |
boolean |
marketplace_offering_uuid |
string |
marketplace_offering_name |
string |
marketplace_offering_plugin_options |
object (free-form) |
marketplace_category_uuid |
string |
marketplace_category_name |
string |
marketplace_resource_uuid |
string |
marketplace_plan_uuid |
string |
marketplace_resource_state |
string |
is_usage_based |
boolean |
is_limit_based |
boolean |
Synchronize resource state
Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openportal_allocations_pull
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
202 -
| Field | Type |
|---|---|
detail |
string |
409 -
| Field | Type |
|---|---|
detail |
string |
Unlink resource
Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openportal_allocations_unlink
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Update
1 2 3 4 5 6 7 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | |
- Model Source:
AllocationRequest - API Source:
openportal_allocations_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
name |
string | ✓ |
description |
string | |
service_settings |
string (uri) | ✓ |
project |
string (uri) | ✓ |
node_limit |
integer (int64) | |
groupname |
string |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
description |
string |
service_name |
string |
service_settings |
string (uri) |
service_settings_uuid |
string (uuid) |
service_settings_state |
string |
service_settings_error_message |
string |
project |
string (uri) |
project_name |
string |
project_uuid |
string (uuid) |
customer |
string (uri) |
customer_uuid |
string (uuid) |
customer_name |
string |
customer_native_name |
string |
customer_abbreviation |
string |
error_message |
string |
error_traceback |
string |
resource_type |
string |
state |
any |
created |
string (date-time) |
modified |
string (date-time) |
backend_id |
string |
access_url |
string |
node_limit |
integer (int64) |
groupname |
string |
node_usage |
string (decimal) |
is_active |
boolean |
marketplace_offering_uuid |
string |
marketplace_offering_name |
string |
marketplace_offering_plugin_options |
object (free-form) |
marketplace_category_uuid |
string |
marketplace_category_name |
string |
marketplace_resource_uuid |
string |
marketplace_plan_uuid |
string |
marketplace_resource_state |
string |
is_usage_based |
boolean |
is_limit_based |
boolean |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedAllocationRequest - API Source:
openportal_allocations_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
name |
string | |
description |
string | |
node_limit |
integer (int64) | |
groupname |
string |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
description |
string |
service_name |
string |
service_settings |
string (uri) |
service_settings_uuid |
string (uuid) |
service_settings_state |
string |
service_settings_error_message |
string |
project |
string (uri) |
project_name |
string |
project_uuid |
string (uuid) |
customer |
string (uri) |
customer_uuid |
string (uuid) |
customer_name |
string |
customer_native_name |
string |
customer_abbreviation |
string |
error_message |
string |
error_traceback |
string |
resource_type |
string |
state |
any |
created |
string (date-time) |
modified |
string (date-time) |
backend_id |
string |
access_url |
string |
node_limit |
integer (int64) |
groupname |
string |
node_usage |
string (decimal) |
is_active |
boolean |
marketplace_offering_uuid |
string |
marketplace_offering_name |
string |
marketplace_offering_plugin_options |
object (free-form) |
marketplace_category_uuid |
string |
marketplace_category_name |
string |
marketplace_resource_uuid |
string |
marketplace_plan_uuid |
string |
marketplace_resource_state |
string |
is_usage_based |
boolean |
is_limit_based |
boolean |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openportal_allocations_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
Mark resource as ERRED
Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
SetErredRequest - API Source:
openportal_allocations_set_erred
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
error_message |
string | |
error_traceback |
string |
200 -
| Field | Type |
|---|---|
detail |
string |
Set limits
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
AllocationSetLimitsRequest - API Source:
openportal_allocations_set_limits
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
node_limit |
integer | ✓ |
200 -
| Field | Type |
|---|---|
node_limit |
integer |
Mark resource as OK
Manually transition the resource to OK state and clear error fields. Staff-only operation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openportal_allocations_set_ok
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
detail |
string |
Openportal Associations
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/openportal-associations/ |
List Openportal Associations |
| GET | /api/openportal-associations/{uuid}/ |
Retrieve |
List Openportal Associations
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
openportal_associations_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
allocation |
string (uri) | |
allocation_uuid |
string (uuid) | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
uuid |
string (uuid) |
username |
string |
groupname |
string |
useridentifier |
string |
allocation |
string (uri) |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openportal_associations_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
username |
string |
groupname |
string |
useridentifier |
string |
allocation |
string (uri) |
Openportal Managed Projects
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/openportal-managed-projects/ |
List all managed projects |
| GET | /api/openportal-managed-projects/{identifier}/{destination}/ |
Retrieve a managed project |
| Other Actions | ||
| POST | /api/openportal-managed-projects/{identifier}/{destination}/approve/ |
Approve managed project request |
| POST | /api/openportal-managed-projects/{identifier}/{destination}/attach/ |
Attach a project to this managed project |
| POST | /api/openportal-managed-projects/{identifier}/{destination}/detach/ |
Detach the project from this managed project |
| POST | /api/openportal-managed-projects/{identifier}/{destination}/reject/ |
Reject managed project request |
| DELETE | /api/openportal-managed-projects/{identifier}/{destination}/delete/ |
Delete ManagedProject object |
Core CRUD
List all managed projects
List all managed projects
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 | |
- Model Source:
RemoteProjectUpdateRequestStateEnum - API Source:
openportal_managed_projects_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
identifier |
string | |
local_identifier |
string | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
project |
string (uri) | |
project_template |
string (uri) | |
project_template_uuid |
string (uuid) | |
project_uuid |
string (uuid) | |
state |
array |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
state |
string | |
created |
string (date-time) | |
reviewed_at |
string (date-time) | Timestamp when the review was completed |
reviewed_by_full_name |
string | |
reviewed_by_uuid |
string (uuid) | |
review_comment |
string | Optional comment provided during review |
identifier |
string | |
destination |
string | The destination used to send instructions from the remote portal. |
details |
any | Details of the project as provided by the remote OpenPortal. |
project |
string (uri) | |
project_data |
any | |
project_template |
string (uri) | |
project_template_data |
any | |
local_identifier |
string | The local project identifier in this portal. |
Retrieve a managed project
Retrieve a managed project
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- API Source:
openportal_managed_projects_retrieve_get
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Name | Type | Required | Description |
|---|---|---|---|
destination |
string | ✓ | The destination of the managed project |
identifier |
string | ✓ | The identifier of the managed project |
200 -
| Field | Type | Description |
|---|---|---|
state |
string | |
created |
string (date-time) | |
reviewed_at |
string (date-time) | Timestamp when the review was completed |
reviewed_by_full_name |
string | |
reviewed_by_uuid |
string (uuid) | |
review_comment |
string | Optional comment provided during review |
identifier |
string | |
destination |
string | The destination used to send instructions from the remote portal. |
details |
any | Details of the project as provided by the remote OpenPortal. |
project |
string (uri) | |
project_data |
any | |
project_template |
string (uri) | |
project_template_data |
any | |
local_identifier |
string | The local project identifier in this portal. |
Other Actions
Approve managed project request
Approve managed project request
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
- Model Source:
ReviewCommentRequest - API Source:
openportal_managed_projects_approve
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Name | Type | Required | Description |
|---|---|---|---|
destination |
string | ✓ | The destination of the managed project |
identifier |
string | ✓ | The identifier of the managed project |
| Field | Type | Required | Description |
|---|---|---|---|
comment |
string | Optional comment for review |
200 - No response body
Attach a project to this managed project
Attach a project to this managed project
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
ProjectAttachRequest - API Source:
openportal_managed_projects_attach
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required | Description |
|---|---|---|---|
destination |
string | ✓ | The destination of the managed project |
identifier |
string | ✓ | The identifier of the managed project |
| Field | Type | Required | Description |
|---|---|---|---|
project_uuid |
string (uuid) | ✓ | UUID of the project to attach to this managed project |
200 - No response body
Detach the project from this managed project
Detach the project from this managed project
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- API Source:
openportal_managed_projects_detach
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Name | Type | Required | Description |
|---|---|---|---|
destination |
string | ✓ | The destination of the managed project |
identifier |
string | ✓ | The identifier of the managed project |
200 - No response body
Reject managed project request
Reject managed project request
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
- Model Source:
ReviewCommentRequest - API Source:
openportal_managed_projects_reject
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Name | Type | Required | Description |
|---|---|---|---|
destination |
string | ✓ | The destination of the managed project |
identifier |
string | ✓ | The identifier of the managed project |
| Field | Type | Required | Description |
|---|---|---|---|
comment |
string | Optional comment for review |
200 - No response body
Delete ManagedProject object
Delete ManagedProject object
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- API Source:
openportal_managed_projects_delete_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Name | Type | Required | Description |
|---|---|---|---|
destination |
string | ✓ | The destination of the managed project |
identifier |
string | ✓ | The identifier of the managed project |
204 - No response body
Openportal Project Template
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/openportal-project-template/ |
List Openportal Project Template |
| GET | /api/openportal-project-template/{uuid}/ |
Retrieve |
| POST | /api/openportal-project-template/ |
Create ProjectTemplate object |
| PUT | /api/openportal-project-template/{uuid}/ |
Update ProjectTemplate object (full update) |
| PATCH | /api/openportal-project-template/{uuid}/ |
Partially update ProjectTemplate object |
| DELETE | /api/openportal-project-template/{uuid}/ |
Delete |
| Other Actions | ||
| DELETE | /api/openportal-project-template/{uuid}/delete/ |
Delete ProjectTemplate object |
Core CRUD
List Openportal Project Template
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
openportal_project_template_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
name |
string | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
portal |
string | |
uuid |
string (uuid) |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
name |
string | |
offering |
string | The offering for which this template applies. |
provider |
string (uri) | |
provider_data |
any | |
portal |
string | |
key |
string | The key that is used to authenticate requests for this class. |
customer |
string (uri) | |
customer_data |
any | |
shortname |
string | |
offerings |
array of string (uri)s | |
offerings_data |
array of objects | |
offerings_data.url |
string (uri) | |
offerings_data.uuid |
string (uuid) | |
offerings_data.created |
string (date-time) | |
offerings_data.name |
string | |
offerings_data.slug |
string | URL-friendly identifier. Only editable by staff users. |
offerings_data.description |
string | |
offerings_data.full_description |
string | |
offerings_data.privacy_policy_link |
string (uri) | |
offerings_data.access_url |
string (uri) | Publicly accessible offering access URL |
offerings_data.endpoints |
array of objects | |
offerings_data.endpoints.uuid |
string (uuid) | |
offerings_data.endpoints.name |
string | |
offerings_data.endpoints.url |
string | URL of the access endpoint |
offerings_data.software_catalogs |
array of objects | |
offerings_data.software_catalogs.uuid |
string (uuid) | |
offerings_data.software_catalogs.catalog |
any | |
offerings_data.software_catalogs.enabled_cpu_family |
any | List of enabled CPU families: ['x86_64', 'aarch64'] |
offerings_data.software_catalogs.enabled_cpu_microarchitectures |
any | List of enabled CPU microarchitectures: ['generic', 'zen3'] |
offerings_data.software_catalogs.package_count |
integer | |
offerings_data.software_catalogs.partition |
any | |
offerings_data.partitions |
array of objects | |
offerings_data.partitions.uuid |
string (uuid) | |
offerings_data.partitions.partition_name |
string | Name of the SLURM partition |
offerings_data.partitions.cpu_bind |
integer | Default task binding policy (SLURM cpu_bind) |
offerings_data.partitions.def_cpu_per_gpu |
integer | Default CPUs allocated per GPU |
offerings_data.partitions.max_cpus_per_node |
integer | Maximum allocated CPUs per node |
offerings_data.partitions.max_cpus_per_socket |
integer | Maximum allocated CPUs per socket |
offerings_data.partitions.def_mem_per_cpu |
integer (int64) | Default memory per CPU in MB |
offerings_data.partitions.def_mem_per_gpu |
integer (int64) | Default memory per GPU in MB |
offerings_data.partitions.def_mem_per_node |
integer (int64) | Default memory per node in MB |
offerings_data.partitions.max_mem_per_cpu |
integer (int64) | Maximum memory per CPU in MB |
offerings_data.partitions.max_mem_per_node |
integer (int64) | Maximum memory per node in MB |
offerings_data.partitions.default_time |
integer | Default time limit in minutes |
offerings_data.partitions.max_time |
integer | Maximum time limit in minutes |
offerings_data.partitions.grace_time |
integer | Preemption grace time in seconds |
offerings_data.partitions.max_nodes |
integer | Maximum nodes per job |
offerings_data.partitions.min_nodes |
integer | Minimum nodes per job |
offerings_data.partitions.exclusive_topo |
boolean | Exclusive topology access required |
offerings_data.partitions.exclusive_user |
boolean | Exclusive user access required |
offerings_data.partitions.priority_tier |
integer | Priority tier for scheduling and preemption |
offerings_data.partitions.qos |
string | Quality of Service (QOS) name |
offerings_data.partitions.req_resv |
boolean | Require reservation for job allocation |
offerings_data.roles |
array of objects | |
offerings_data.roles.uuid |
string (uuid) | |
offerings_data.roles.name |
string | |
offerings_data.roles.url |
string (uri) | |
offerings_data.customer |
string (uri) | |
offerings_data.customer_uuid |
string (uuid) | |
offerings_data.customer_name |
string | |
offerings_data.project |
string (uri) | |
offerings_data.project_uuid |
string (uuid) | |
offerings_data.project_name |
string | |
offerings_data.category |
string (uri) | |
offerings_data.category_uuid |
string (uuid) | |
offerings_data.category_title |
string | |
offerings_data.attributes |
object (free-form) | |
offerings_data.options |
any | |
offerings_data.resource_options |
any | |
offerings_data.components |
array of objects | |
offerings_data.components.uuid |
string (uuid) | |
offerings_data.components.billing_type |
string | Enum: fixed, usage, limit, one, few |
offerings_data.components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
offerings_data.components.name |
string | Display name for the measured unit, for example, Floating IP. |
offerings_data.components.description |
string | |
offerings_data.components.measured_unit |
string | Unit of measurement, for example, GB. |
offerings_data.components.unit_factor |
integer | The conversion factor from backend units to measured_unit |
offerings_data.components.limit_period |
any | |
offerings_data.components.limit_amount |
integer | |
offerings_data.components.article_code |
string | |
offerings_data.components.max_value |
integer | |
offerings_data.components.min_value |
integer | |
offerings_data.components.max_available_limit |
integer | |
offerings_data.components.is_boolean |
boolean | |
offerings_data.components.default_limit |
integer | |
offerings_data.components.factor |
integer | |
offerings_data.components.is_builtin |
boolean | |
offerings_data.components.is_prepaid |
boolean | |
offerings_data.components.overage_component |
string (uuid) | |
offerings_data.components.min_prepaid_duration |
integer | |
offerings_data.components.max_prepaid_duration |
integer | |
offerings_data.plugin_options |
any | |
offerings_data.secret_options |
any | |
offerings_data.service_attributes |
object (free-form) | |
offerings_data.state |
any | |
offerings_data.vendor_details |
string | |
offerings_data.getting_started |
string | |
offerings_data.integration_guide |
string | |
offerings_data.thumbnail |
string (uri) | |
offerings_data.order_count |
integer | |
offerings_data.plans |
array of objects | |
offerings_data.plans.url |
string (uri) | |
offerings_data.plans.uuid |
string (uuid) | |
offerings_data.plans.name |
string | |
offerings_data.plans.description |
string | |
offerings_data.plans.article_code |
string | |
offerings_data.plans.max_amount |
integer | Maximum number of plans that could be active. Plan is disabled when maximum amount is reached. |
offerings_data.plans.archived |
boolean | Forbids creation of new resources. |
offerings_data.plans.is_active |
boolean | |
offerings_data.plans.unit_price |
string (decimal) | |
offerings_data.plans.unit |
string | Enum: month, quarter, half_month, day, hour, quantity |
offerings_data.plans.init_price |
number (double) | |
offerings_data.plans.switch_price |
number (double) | |
offerings_data.plans.backend_id |
string | |
offerings_data.plans.organization_groups |
array of objects | |
offerings_data.plans.organization_groups.uuid |
string (uuid) | |
offerings_data.plans.organization_groups.url |
string (uri) | |
offerings_data.plans.organization_groups.name |
string | |
offerings_data.plans.organization_groups.parent_uuid |
string (uuid) | UUID of the parent organization group |
offerings_data.plans.organization_groups.parent_name |
string | Name of the parent organization group |
offerings_data.plans.organization_groups.parent |
string (uri) | |
offerings_data.plans.organization_groups.customers_count |
integer | Number of customers in this organization group |
offerings_data.plans.components |
array of objects | |
offerings_data.plans.components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
offerings_data.plans.components.name |
string | Display name for the measured unit, for example, Floating IP. |
offerings_data.plans.components.measured_unit |
string | Unit of measurement, for example, GB. |
offerings_data.plans.components.amount |
integer | |
offerings_data.plans.components.price |
string (decimal) | |
offerings_data.plans.components.future_price |
string (decimal) | |
offerings_data.plans.components.discount_threshold |
integer | Minimum amount to be eligible for discount. |
offerings_data.plans.components.discount_rate |
integer | Discount rate in percentage. |
offerings_data.plans.prices |
object (free-form) | |
offerings_data.plans.future_prices |
object (free-form) | |
offerings_data.plans.quotas |
object (free-form) | |
offerings_data.plans.resources_count |
integer | |
offerings_data.plans.plan_type |
string | |
offerings_data.plans.minimal_price |
number (double) | |
offerings_data.screenshots |
array of objects | |
offerings_data.screenshots.name |
string | |
offerings_data.screenshots.uuid |
string (uuid) | |
offerings_data.screenshots.description |
string | |
offerings_data.screenshots.image |
string (uri) | |
offerings_data.screenshots.thumbnail |
string (uri) | |
offerings_data.screenshots.created |
string (date-time) | |
offerings_data.type |
string | |
offerings_data.shared |
boolean | Accessible to all customers. |
offerings_data.billable |
boolean | Purchase and usage is invoiced. |
offerings_data.scope |
string | |
offerings_data.scope_uuid |
string (uuid) | |
offerings_data.scope_name |
string (uuid) | |
offerings_data.scope_state |
any | |
offerings_data.scope_error_message |
string | |
offerings_data.files |
array of objects | |
offerings_data.files.name |
string | |
offerings_data.files.created |
string (date-time) | |
offerings_data.files.file |
string (uri) | |
offerings_data.quotas |
array of objects | |
offerings_data.quotas.name |
string | |
offerings_data.quotas.usage |
integer | |
offerings_data.quotas.limit |
integer | |
offerings_data.paused_reason |
string | |
offerings_data.datacite_doi |
string | |
offerings_data.citation_count |
integer | Number of citations of a DOI |
offerings_data.latitude |
number (double) | |
offerings_data.longitude |
number (double) | |
offerings_data.country |
any | Country code (ISO 3166-1 alpha-2) |
offerings_data.backend_id |
string | |
offerings_data.backend_id_rules |
any | Validation rules for resource backend_id: format regex and uniqueness scope. |
offerings_data.organization_groups |
array of objects | |
offerings_data.organization_groups.uuid |
string (uuid) | |
offerings_data.organization_groups.url |
string (uri) | |
offerings_data.organization_groups.name |
string | |
offerings_data.organization_groups.parent_uuid |
string (uuid) | UUID of the parent organization group |
offerings_data.organization_groups.parent_name |
string | Name of the parent organization group |
offerings_data.organization_groups.parent |
string (uri) | |
offerings_data.organization_groups.customers_count |
integer | Number of customers in this organization group |
offerings_data.tags |
array of objects | |
offerings_data.tags.uuid |
string (uuid) | |
offerings_data.tags.name |
string | |
offerings_data.image |
string (uri) | |
offerings_data.total_customers |
integer | |
offerings_data.total_cost |
integer | |
offerings_data.total_cost_estimated |
integer | |
offerings_data.parent_description |
string | |
offerings_data.parent_uuid |
string (uuid) | |
offerings_data.parent_name |
string | |
offerings_data.backend_metadata |
any | |
offerings_data.has_compliance_requirements |
boolean | |
offerings_data.billing_type_classification |
string | Classify offering components by billing type. Returns 'limit_only', 'usage_only', or 'mixed'. |
offerings_data.compliance_checklist |
string (uri) | |
offerings_data.integration_status |
array of objects | |
offerings_data.integration_status.agent_type |
any | |
offerings_data.integration_status.status |
string | |
offerings_data.integration_status.last_request_timestamp |
string (date-time) | |
offerings_data.integration_status.service_name |
string | |
offerings_data.google_calendar_is_public |
boolean | |
offerings_data.google_calendar_link |
string | Get the Google Calendar link for an offering. |
approval_limit |
string (decimal) | The credit limit beyond which requests need to be approved by a local admin. If this is None, then no local approval is required. If this is set to 0, then all requests (including creating the project) need to be approved. |
max_credit_limit |
string (decimal) | The maximum credit limit for any projects created in this class. Any requests beyond this limit are automatically rejected. If this is None, then no maximum limit is set. If this is set to 0, then no projects can be created in this class. |
allocation_units_mapping |
any | The mapping of credits to allocation units, i.e. how many allocation units to award per credit allocated. |
role_mapping |
any | The mapping of role names from the remote portal to role information in this portal for users in projects created in this class. |
role_mapping_data |
object (free-form) | Serialize the role mapping dictionary returned by get_role_mapping() |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openportal_project_template_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
name |
string | |
offering |
string | The offering for which this template applies. |
provider |
string (uri) | |
provider_data |
any | |
portal |
string | |
key |
string | The key that is used to authenticate requests for this class. |
customer |
string (uri) | |
customer_data |
any | |
shortname |
string | |
offerings |
array of string (uri)s | |
offerings_data |
array of objects | |
offerings_data.url |
string (uri) | |
offerings_data.uuid |
string (uuid) | |
offerings_data.created |
string (date-time) | |
offerings_data.name |
string | |
offerings_data.slug |
string | URL-friendly identifier. Only editable by staff users. |
offerings_data.description |
string | |
offerings_data.full_description |
string | |
offerings_data.privacy_policy_link |
string (uri) | |
offerings_data.access_url |
string (uri) | Publicly accessible offering access URL |
offerings_data.endpoints |
array of objects | |
offerings_data.endpoints.uuid |
string (uuid) | |
offerings_data.endpoints.name |
string | |
offerings_data.endpoints.url |
string | URL of the access endpoint |
offerings_data.software_catalogs |
array of objects | |
offerings_data.software_catalogs.uuid |
string (uuid) | |
offerings_data.software_catalogs.catalog |
any | |
offerings_data.software_catalogs.enabled_cpu_family |
any | List of enabled CPU families: ['x86_64', 'aarch64'] |
offerings_data.software_catalogs.enabled_cpu_microarchitectures |
any | List of enabled CPU microarchitectures: ['generic', 'zen3'] |
offerings_data.software_catalogs.package_count |
integer | |
offerings_data.software_catalogs.partition |
any | |
offerings_data.partitions |
array of objects | |
offerings_data.partitions.uuid |
string (uuid) | |
offerings_data.partitions.partition_name |
string | Name of the SLURM partition |
offerings_data.partitions.cpu_bind |
integer | Default task binding policy (SLURM cpu_bind) |
offerings_data.partitions.def_cpu_per_gpu |
integer | Default CPUs allocated per GPU |
offerings_data.partitions.max_cpus_per_node |
integer | Maximum allocated CPUs per node |
offerings_data.partitions.max_cpus_per_socket |
integer | Maximum allocated CPUs per socket |
offerings_data.partitions.def_mem_per_cpu |
integer (int64) | Default memory per CPU in MB |
offerings_data.partitions.def_mem_per_gpu |
integer (int64) | Default memory per GPU in MB |
offerings_data.partitions.def_mem_per_node |
integer (int64) | Default memory per node in MB |
offerings_data.partitions.max_mem_per_cpu |
integer (int64) | Maximum memory per CPU in MB |
offerings_data.partitions.max_mem_per_node |
integer (int64) | Maximum memory per node in MB |
offerings_data.partitions.default_time |
integer | Default time limit in minutes |
offerings_data.partitions.max_time |
integer | Maximum time limit in minutes |
offerings_data.partitions.grace_time |
integer | Preemption grace time in seconds |
offerings_data.partitions.max_nodes |
integer | Maximum nodes per job |
offerings_data.partitions.min_nodes |
integer | Minimum nodes per job |
offerings_data.partitions.exclusive_topo |
boolean | Exclusive topology access required |
offerings_data.partitions.exclusive_user |
boolean | Exclusive user access required |
offerings_data.partitions.priority_tier |
integer | Priority tier for scheduling and preemption |
offerings_data.partitions.qos |
string | Quality of Service (QOS) name |
offerings_data.partitions.req_resv |
boolean | Require reservation for job allocation |
offerings_data.roles |
array of objects | |
offerings_data.roles.uuid |
string (uuid) | |
offerings_data.roles.name |
string | |
offerings_data.roles.url |
string (uri) | |
offerings_data.customer |
string (uri) | |
offerings_data.customer_uuid |
string (uuid) | |
offerings_data.customer_name |
string | |
offerings_data.project |
string (uri) | |
offerings_data.project_uuid |
string (uuid) | |
offerings_data.project_name |
string | |
offerings_data.category |
string (uri) | |
offerings_data.category_uuid |
string (uuid) | |
offerings_data.category_title |
string | |
offerings_data.attributes |
object (free-form) | |
offerings_data.options |
any | |
offerings_data.resource_options |
any | |
offerings_data.components |
array of objects | |
offerings_data.components.uuid |
string (uuid) | |
offerings_data.components.billing_type |
string | Enum: fixed, usage, limit, one, few |
offerings_data.components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
offerings_data.components.name |
string | Display name for the measured unit, for example, Floating IP. |
offerings_data.components.description |
string | |
offerings_data.components.measured_unit |
string | Unit of measurement, for example, GB. |
offerings_data.components.unit_factor |
integer | The conversion factor from backend units to measured_unit |
offerings_data.components.limit_period |
any | |
offerings_data.components.limit_amount |
integer | |
offerings_data.components.article_code |
string | |
offerings_data.components.max_value |
integer | |
offerings_data.components.min_value |
integer | |
offerings_data.components.max_available_limit |
integer | |
offerings_data.components.is_boolean |
boolean | |
offerings_data.components.default_limit |
integer | |
offerings_data.components.factor |
integer | |
offerings_data.components.is_builtin |
boolean | |
offerings_data.components.is_prepaid |
boolean | |
offerings_data.components.overage_component |
string (uuid) | |
offerings_data.components.min_prepaid_duration |
integer | |
offerings_data.components.max_prepaid_duration |
integer | |
offerings_data.plugin_options |
any | |
offerings_data.secret_options |
any | |
offerings_data.service_attributes |
object (free-form) | |
offerings_data.state |
any | |
offerings_data.vendor_details |
string | |
offerings_data.getting_started |
string | |
offerings_data.integration_guide |
string | |
offerings_data.thumbnail |
string (uri) | |
offerings_data.order_count |
integer | |
offerings_data.plans |
array of objects | |
offerings_data.plans.url |
string (uri) | |
offerings_data.plans.uuid |
string (uuid) | |
offerings_data.plans.name |
string | |
offerings_data.plans.description |
string | |
offerings_data.plans.article_code |
string | |
offerings_data.plans.max_amount |
integer | Maximum number of plans that could be active. Plan is disabled when maximum amount is reached. |
offerings_data.plans.archived |
boolean | Forbids creation of new resources. |
offerings_data.plans.is_active |
boolean | |
offerings_data.plans.unit_price |
string (decimal) | |
offerings_data.plans.unit |
string | Enum: month, quarter, half_month, day, hour, quantity |
offerings_data.plans.init_price |
number (double) | |
offerings_data.plans.switch_price |
number (double) | |
offerings_data.plans.backend_id |
string | |
offerings_data.plans.organization_groups |
array of objects | |
offerings_data.plans.organization_groups.uuid |
string (uuid) | |
offerings_data.plans.organization_groups.url |
string (uri) | |
offerings_data.plans.organization_groups.name |
string | |
offerings_data.plans.organization_groups.parent_uuid |
string (uuid) | UUID of the parent organization group |
offerings_data.plans.organization_groups.parent_name |
string | Name of the parent organization group |
offerings_data.plans.organization_groups.parent |
string (uri) | |
offerings_data.plans.organization_groups.customers_count |
integer | Number of customers in this organization group |
offerings_data.plans.components |
array of objects | |
offerings_data.plans.components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
offerings_data.plans.components.name |
string | Display name for the measured unit, for example, Floating IP. |
offerings_data.plans.components.measured_unit |
string | Unit of measurement, for example, GB. |
offerings_data.plans.components.amount |
integer | |
offerings_data.plans.components.price |
string (decimal) | |
offerings_data.plans.components.future_price |
string (decimal) | |
offerings_data.plans.components.discount_threshold |
integer | Minimum amount to be eligible for discount. |
offerings_data.plans.components.discount_rate |
integer | Discount rate in percentage. |
offerings_data.plans.prices |
object (free-form) | |
offerings_data.plans.future_prices |
object (free-form) | |
offerings_data.plans.quotas |
object (free-form) | |
offerings_data.plans.resources_count |
integer | |
offerings_data.plans.plan_type |
string | |
offerings_data.plans.minimal_price |
number (double) | |
offerings_data.screenshots |
array of objects | |
offerings_data.screenshots.name |
string | |
offerings_data.screenshots.uuid |
string (uuid) | |
offerings_data.screenshots.description |
string | |
offerings_data.screenshots.image |
string (uri) | |
offerings_data.screenshots.thumbnail |
string (uri) | |
offerings_data.screenshots.created |
string (date-time) | |
offerings_data.type |
string | |
offerings_data.shared |
boolean | Accessible to all customers. |
offerings_data.billable |
boolean | Purchase and usage is invoiced. |
offerings_data.scope |
string | |
offerings_data.scope_uuid |
string (uuid) | |
offerings_data.scope_name |
string (uuid) | |
offerings_data.scope_state |
any | |
offerings_data.scope_error_message |
string | |
offerings_data.files |
array of objects | |
offerings_data.files.name |
string | |
offerings_data.files.created |
string (date-time) | |
offerings_data.files.file |
string (uri) | |
offerings_data.quotas |
array of objects | |
offerings_data.quotas.name |
string | |
offerings_data.quotas.usage |
integer | |
offerings_data.quotas.limit |
integer | |
offerings_data.paused_reason |
string | |
offerings_data.datacite_doi |
string | |
offerings_data.citation_count |
integer | Number of citations of a DOI |
offerings_data.latitude |
number (double) | |
offerings_data.longitude |
number (double) | |
offerings_data.country |
any | Country code (ISO 3166-1 alpha-2) |
offerings_data.backend_id |
string | |
offerings_data.backend_id_rules |
any | Validation rules for resource backend_id: format regex and uniqueness scope. |
offerings_data.organization_groups |
array of objects | |
offerings_data.organization_groups.uuid |
string (uuid) | |
offerings_data.organization_groups.url |
string (uri) | |
offerings_data.organization_groups.name |
string | |
offerings_data.organization_groups.parent_uuid |
string (uuid) | UUID of the parent organization group |
offerings_data.organization_groups.parent_name |
string | Name of the parent organization group |
offerings_data.organization_groups.parent |
string (uri) | |
offerings_data.organization_groups.customers_count |
integer | Number of customers in this organization group |
offerings_data.tags |
array of objects | |
offerings_data.tags.uuid |
string (uuid) | |
offerings_data.tags.name |
string | |
offerings_data.image |
string (uri) | |
offerings_data.total_customers |
integer | |
offerings_data.total_cost |
integer | |
offerings_data.total_cost_estimated |
integer | |
offerings_data.parent_description |
string | |
offerings_data.parent_uuid |
string (uuid) | |
offerings_data.parent_name |
string | |
offerings_data.backend_metadata |
any | |
offerings_data.has_compliance_requirements |
boolean | |
offerings_data.billing_type_classification |
string | Classify offering components by billing type. Returns 'limit_only', 'usage_only', or 'mixed'. |
offerings_data.compliance_checklist |
string (uri) | |
offerings_data.integration_status |
array of objects | |
offerings_data.integration_status.agent_type |
any | |
offerings_data.integration_status.status |
string | |
offerings_data.integration_status.last_request_timestamp |
string (date-time) | |
offerings_data.integration_status.service_name |
string | |
offerings_data.google_calendar_is_public |
boolean | |
offerings_data.google_calendar_link |
string | Get the Google Calendar link for an offering. |
approval_limit |
string (decimal) | The credit limit beyond which requests need to be approved by a local admin. If this is None, then no local approval is required. If this is set to 0, then all requests (including creating the project) need to be approved. |
max_credit_limit |
string (decimal) | The maximum credit limit for any projects created in this class. Any requests beyond this limit are automatically rejected. If this is None, then no maximum limit is set. If this is set to 0, then no projects can be created in this class. |
allocation_units_mapping |
any | The mapping of credits to allocation units, i.e. how many allocation units to award per credit allocated. |
role_mapping |
any | The mapping of role names from the remote portal to role information in this portal for users in projects created in this class. |
role_mapping_data |
object (free-form) | Serialize the role mapping dictionary returned by get_role_mapping() |
Create ProjectTemplate object
Create ProjectTemplate object
1 2 3 4 5 6 7 8 9 10 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 | |
- Model Source:
ProjectTemplateRequest - API Source:
openportal_project_template_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ✓ | |
offering |
string | ✓ | The offering for which this template applies. |
provider |
string (uri) | ✓ | |
portal |
string | ✓ | |
key |
string | The key that is used to authenticate requests for this class. | |
customer |
string (uri) | ✓ | |
shortname |
string | ||
offerings |
array of string (uri)s | ✓ | |
approval_limit |
string (decimal) | The credit limit beyond which requests need to be approved by a local admin. If this is None, then no local approval is required. If this is set to 0, then all requests (including creating the project) need to be approved. | |
max_credit_limit |
string (decimal) | The maximum credit limit for any projects created in this class. Any requests beyond this limit are automatically rejected. If this is None, then no maximum limit is set. If this is set to 0, then no projects can be created in this class. | |
allocation_units_mapping |
any | The mapping of credits to allocation units, i.e. how many allocation units to award per credit allocated. | |
role_mapping |
any | The mapping of role names from the remote portal to role information in this portal for users in projects created in this class. |
201 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
name |
string | |
offering |
string | The offering for which this template applies. |
provider |
string (uri) | |
provider_data |
any | |
portal |
string | |
key |
string | The key that is used to authenticate requests for this class. |
customer |
string (uri) | |
customer_data |
any | |
shortname |
string | |
offerings |
array of string (uri)s | |
offerings_data |
array of objects | |
offerings_data.url |
string (uri) | |
offerings_data.uuid |
string (uuid) | |
offerings_data.created |
string (date-time) | |
offerings_data.name |
string | |
offerings_data.slug |
string | URL-friendly identifier. Only editable by staff users. |
offerings_data.description |
string | |
offerings_data.full_description |
string | |
offerings_data.privacy_policy_link |
string (uri) | |
offerings_data.access_url |
string (uri) | Publicly accessible offering access URL |
offerings_data.endpoints |
array of objects | |
offerings_data.endpoints.uuid |
string (uuid) | |
offerings_data.endpoints.name |
string | |
offerings_data.endpoints.url |
string | URL of the access endpoint |
offerings_data.software_catalogs |
array of objects | |
offerings_data.software_catalogs.uuid |
string (uuid) | |
offerings_data.software_catalogs.catalog |
any | |
offerings_data.software_catalogs.enabled_cpu_family |
any | List of enabled CPU families: ['x86_64', 'aarch64'] |
offerings_data.software_catalogs.enabled_cpu_microarchitectures |
any | List of enabled CPU microarchitectures: ['generic', 'zen3'] |
offerings_data.software_catalogs.package_count |
integer | |
offerings_data.software_catalogs.partition |
any | |
offerings_data.partitions |
array of objects | |
offerings_data.partitions.uuid |
string (uuid) | |
offerings_data.partitions.partition_name |
string | Name of the SLURM partition |
offerings_data.partitions.cpu_bind |
integer | Default task binding policy (SLURM cpu_bind) |
offerings_data.partitions.def_cpu_per_gpu |
integer | Default CPUs allocated per GPU |
offerings_data.partitions.max_cpus_per_node |
integer | Maximum allocated CPUs per node |
offerings_data.partitions.max_cpus_per_socket |
integer | Maximum allocated CPUs per socket |
offerings_data.partitions.def_mem_per_cpu |
integer (int64) | Default memory per CPU in MB |
offerings_data.partitions.def_mem_per_gpu |
integer (int64) | Default memory per GPU in MB |
offerings_data.partitions.def_mem_per_node |
integer (int64) | Default memory per node in MB |
offerings_data.partitions.max_mem_per_cpu |
integer (int64) | Maximum memory per CPU in MB |
offerings_data.partitions.max_mem_per_node |
integer (int64) | Maximum memory per node in MB |
offerings_data.partitions.default_time |
integer | Default time limit in minutes |
offerings_data.partitions.max_time |
integer | Maximum time limit in minutes |
offerings_data.partitions.grace_time |
integer | Preemption grace time in seconds |
offerings_data.partitions.max_nodes |
integer | Maximum nodes per job |
offerings_data.partitions.min_nodes |
integer | Minimum nodes per job |
offerings_data.partitions.exclusive_topo |
boolean | Exclusive topology access required |
offerings_data.partitions.exclusive_user |
boolean | Exclusive user access required |
offerings_data.partitions.priority_tier |
integer | Priority tier for scheduling and preemption |
offerings_data.partitions.qos |
string | Quality of Service (QOS) name |
offerings_data.partitions.req_resv |
boolean | Require reservation for job allocation |
offerings_data.roles |
array of objects | |
offerings_data.roles.uuid |
string (uuid) | |
offerings_data.roles.name |
string | |
offerings_data.roles.url |
string (uri) | |
offerings_data.customer |
string (uri) | |
offerings_data.customer_uuid |
string (uuid) | |
offerings_data.customer_name |
string | |
offerings_data.project |
string (uri) | |
offerings_data.project_uuid |
string (uuid) | |
offerings_data.project_name |
string | |
offerings_data.category |
string (uri) | |
offerings_data.category_uuid |
string (uuid) | |
offerings_data.category_title |
string | |
offerings_data.attributes |
object (free-form) | |
offerings_data.options |
any | |
offerings_data.resource_options |
any | |
offerings_data.components |
array of objects | |
offerings_data.components.uuid |
string (uuid) | |
offerings_data.components.billing_type |
string | Enum: fixed, usage, limit, one, few |
offerings_data.components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
offerings_data.components.name |
string | Display name for the measured unit, for example, Floating IP. |
offerings_data.components.description |
string | |
offerings_data.components.measured_unit |
string | Unit of measurement, for example, GB. |
offerings_data.components.unit_factor |
integer | The conversion factor from backend units to measured_unit |
offerings_data.components.limit_period |
any | |
offerings_data.components.limit_amount |
integer | |
offerings_data.components.article_code |
string | |
offerings_data.components.max_value |
integer | |
offerings_data.components.min_value |
integer | |
offerings_data.components.max_available_limit |
integer | |
offerings_data.components.is_boolean |
boolean | |
offerings_data.components.default_limit |
integer | |
offerings_data.components.factor |
integer | |
offerings_data.components.is_builtin |
boolean | |
offerings_data.components.is_prepaid |
boolean | |
offerings_data.components.overage_component |
string (uuid) | |
offerings_data.components.min_prepaid_duration |
integer | |
offerings_data.components.max_prepaid_duration |
integer | |
offerings_data.plugin_options |
any | |
offerings_data.secret_options |
any | |
offerings_data.service_attributes |
object (free-form) | |
offerings_data.state |
any | |
offerings_data.vendor_details |
string | |
offerings_data.getting_started |
string | |
offerings_data.integration_guide |
string | |
offerings_data.thumbnail |
string (uri) | |
offerings_data.order_count |
integer | |
offerings_data.plans |
array of objects | |
offerings_data.plans.url |
string (uri) | |
offerings_data.plans.uuid |
string (uuid) | |
offerings_data.plans.name |
string | |
offerings_data.plans.description |
string | |
offerings_data.plans.article_code |
string | |
offerings_data.plans.max_amount |
integer | Maximum number of plans that could be active. Plan is disabled when maximum amount is reached. |
offerings_data.plans.archived |
boolean | Forbids creation of new resources. |
offerings_data.plans.is_active |
boolean | |
offerings_data.plans.unit_price |
string (decimal) | |
offerings_data.plans.unit |
string | Enum: month, quarter, half_month, day, hour, quantity |
offerings_data.plans.init_price |
number (double) | |
offerings_data.plans.switch_price |
number (double) | |
offerings_data.plans.backend_id |
string | |
offerings_data.plans.organization_groups |
array of objects | |
offerings_data.plans.organization_groups.uuid |
string (uuid) | |
offerings_data.plans.organization_groups.url |
string (uri) | |
offerings_data.plans.organization_groups.name |
string | |
offerings_data.plans.organization_groups.parent_uuid |
string (uuid) | UUID of the parent organization group |
offerings_data.plans.organization_groups.parent_name |
string | Name of the parent organization group |
offerings_data.plans.organization_groups.parent |
string (uri) | |
offerings_data.plans.organization_groups.customers_count |
integer | Number of customers in this organization group |
offerings_data.plans.components |
array of objects | |
offerings_data.plans.components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
offerings_data.plans.components.name |
string | Display name for the measured unit, for example, Floating IP. |
offerings_data.plans.components.measured_unit |
string | Unit of measurement, for example, GB. |
offerings_data.plans.components.amount |
integer | |
offerings_data.plans.components.price |
string (decimal) | |
offerings_data.plans.components.future_price |
string (decimal) | |
offerings_data.plans.components.discount_threshold |
integer | Minimum amount to be eligible for discount. |
offerings_data.plans.components.discount_rate |
integer | Discount rate in percentage. |
offerings_data.plans.prices |
object (free-form) | |
offerings_data.plans.future_prices |
object (free-form) | |
offerings_data.plans.quotas |
object (free-form) | |
offerings_data.plans.resources_count |
integer | |
offerings_data.plans.plan_type |
string | |
offerings_data.plans.minimal_price |
number (double) | |
offerings_data.screenshots |
array of objects | |
offerings_data.screenshots.name |
string | |
offerings_data.screenshots.uuid |
string (uuid) | |
offerings_data.screenshots.description |
string | |
offerings_data.screenshots.image |
string (uri) | |
offerings_data.screenshots.thumbnail |
string (uri) | |
offerings_data.screenshots.created |
string (date-time) | |
offerings_data.type |
string | |
offerings_data.shared |
boolean | Accessible to all customers. |
offerings_data.billable |
boolean | Purchase and usage is invoiced. |
offerings_data.scope |
string | |
offerings_data.scope_uuid |
string (uuid) | |
offerings_data.scope_name |
string (uuid) | |
offerings_data.scope_state |
any | |
offerings_data.scope_error_message |
string | |
offerings_data.files |
array of objects | |
offerings_data.files.name |
string | |
offerings_data.files.created |
string (date-time) | |
offerings_data.files.file |
string (uri) | |
offerings_data.quotas |
array of objects | |
offerings_data.quotas.name |
string | |
offerings_data.quotas.usage |
integer | |
offerings_data.quotas.limit |
integer | |
offerings_data.paused_reason |
string | |
offerings_data.datacite_doi |
string | |
offerings_data.citation_count |
integer | Number of citations of a DOI |
offerings_data.latitude |
number (double) | |
offerings_data.longitude |
number (double) | |
offerings_data.country |
any | Country code (ISO 3166-1 alpha-2) |
offerings_data.backend_id |
string | |
offerings_data.backend_id_rules |
any | Validation rules for resource backend_id: format regex and uniqueness scope. |
offerings_data.organization_groups |
array of objects | |
offerings_data.organization_groups.uuid |
string (uuid) | |
offerings_data.organization_groups.url |
string (uri) | |
offerings_data.organization_groups.name |
string | |
offerings_data.organization_groups.parent_uuid |
string (uuid) | UUID of the parent organization group |
offerings_data.organization_groups.parent_name |
string | Name of the parent organization group |
offerings_data.organization_groups.parent |
string (uri) | |
offerings_data.organization_groups.customers_count |
integer | Number of customers in this organization group |
offerings_data.tags |
array of objects | |
offerings_data.tags.uuid |
string (uuid) | |
offerings_data.tags.name |
string | |
offerings_data.image |
string (uri) | |
offerings_data.total_customers |
integer | |
offerings_data.total_cost |
integer | |
offerings_data.total_cost_estimated |
integer | |
offerings_data.parent_description |
string | |
offerings_data.parent_uuid |
string (uuid) | |
offerings_data.parent_name |
string | |
offerings_data.backend_metadata |
any | |
offerings_data.has_compliance_requirements |
boolean | |
offerings_data.billing_type_classification |
string | Classify offering components by billing type. Returns 'limit_only', 'usage_only', or 'mixed'. |
offerings_data.compliance_checklist |
string (uri) | |
offerings_data.integration_status |
array of objects | |
offerings_data.integration_status.agent_type |
any | |
offerings_data.integration_status.status |
string | |
offerings_data.integration_status.last_request_timestamp |
string (date-time) | |
offerings_data.integration_status.service_name |
string | |
offerings_data.google_calendar_is_public |
boolean | |
offerings_data.google_calendar_link |
string | Get the Google Calendar link for an offering. |
approval_limit |
string (decimal) | The credit limit beyond which requests need to be approved by a local admin. If this is None, then no local approval is required. If this is set to 0, then all requests (including creating the project) need to be approved. |
max_credit_limit |
string (decimal) | The maximum credit limit for any projects created in this class. Any requests beyond this limit are automatically rejected. If this is None, then no maximum limit is set. If this is set to 0, then no projects can be created in this class. |
allocation_units_mapping |
any | The mapping of credits to allocation units, i.e. how many allocation units to award per credit allocated. |
role_mapping |
any | The mapping of role names from the remote portal to role information in this portal for users in projects created in this class. |
role_mapping_data |
object (free-form) | Serialize the role mapping dictionary returned by get_role_mapping() |
Update ProjectTemplate object (full update)
Update ProjectTemplate object (full update)
1 2 3 4 5 6 7 8 9 10 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 | |
- Model Source:
ProjectTemplateRequest - API Source:
openportal_project_template_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ✓ | |
offering |
string | ✓ | The offering for which this template applies. |
provider |
string (uri) | ✓ | |
portal |
string | ✓ | |
key |
string | The key that is used to authenticate requests for this class. | |
customer |
string (uri) | ✓ | |
shortname |
string | ||
offerings |
array of string (uri)s | ✓ | |
approval_limit |
string (decimal) | The credit limit beyond which requests need to be approved by a local admin. If this is None, then no local approval is required. If this is set to 0, then all requests (including creating the project) need to be approved. | |
max_credit_limit |
string (decimal) | The maximum credit limit for any projects created in this class. Any requests beyond this limit are automatically rejected. If this is None, then no maximum limit is set. If this is set to 0, then no projects can be created in this class. | |
allocation_units_mapping |
any | The mapping of credits to allocation units, i.e. how many allocation units to award per credit allocated. | |
role_mapping |
any | The mapping of role names from the remote portal to role information in this portal for users in projects created in this class. |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
name |
string | |
offering |
string | The offering for which this template applies. |
provider |
string (uri) | |
provider_data |
any | |
portal |
string | |
key |
string | The key that is used to authenticate requests for this class. |
customer |
string (uri) | |
customer_data |
any | |
shortname |
string | |
offerings |
array of string (uri)s | |
offerings_data |
array of objects | |
offerings_data.url |
string (uri) | |
offerings_data.uuid |
string (uuid) | |
offerings_data.created |
string (date-time) | |
offerings_data.name |
string | |
offerings_data.slug |
string | URL-friendly identifier. Only editable by staff users. |
offerings_data.description |
string | |
offerings_data.full_description |
string | |
offerings_data.privacy_policy_link |
string (uri) | |
offerings_data.access_url |
string (uri) | Publicly accessible offering access URL |
offerings_data.endpoints |
array of objects | |
offerings_data.endpoints.uuid |
string (uuid) | |
offerings_data.endpoints.name |
string | |
offerings_data.endpoints.url |
string | URL of the access endpoint |
offerings_data.software_catalogs |
array of objects | |
offerings_data.software_catalogs.uuid |
string (uuid) | |
offerings_data.software_catalogs.catalog |
any | |
offerings_data.software_catalogs.enabled_cpu_family |
any | List of enabled CPU families: ['x86_64', 'aarch64'] |
offerings_data.software_catalogs.enabled_cpu_microarchitectures |
any | List of enabled CPU microarchitectures: ['generic', 'zen3'] |
offerings_data.software_catalogs.package_count |
integer | |
offerings_data.software_catalogs.partition |
any | |
offerings_data.partitions |
array of objects | |
offerings_data.partitions.uuid |
string (uuid) | |
offerings_data.partitions.partition_name |
string | Name of the SLURM partition |
offerings_data.partitions.cpu_bind |
integer | Default task binding policy (SLURM cpu_bind) |
offerings_data.partitions.def_cpu_per_gpu |
integer | Default CPUs allocated per GPU |
offerings_data.partitions.max_cpus_per_node |
integer | Maximum allocated CPUs per node |
offerings_data.partitions.max_cpus_per_socket |
integer | Maximum allocated CPUs per socket |
offerings_data.partitions.def_mem_per_cpu |
integer (int64) | Default memory per CPU in MB |
offerings_data.partitions.def_mem_per_gpu |
integer (int64) | Default memory per GPU in MB |
offerings_data.partitions.def_mem_per_node |
integer (int64) | Default memory per node in MB |
offerings_data.partitions.max_mem_per_cpu |
integer (int64) | Maximum memory per CPU in MB |
offerings_data.partitions.max_mem_per_node |
integer (int64) | Maximum memory per node in MB |
offerings_data.partitions.default_time |
integer | Default time limit in minutes |
offerings_data.partitions.max_time |
integer | Maximum time limit in minutes |
offerings_data.partitions.grace_time |
integer | Preemption grace time in seconds |
offerings_data.partitions.max_nodes |
integer | Maximum nodes per job |
offerings_data.partitions.min_nodes |
integer | Minimum nodes per job |
offerings_data.partitions.exclusive_topo |
boolean | Exclusive topology access required |
offerings_data.partitions.exclusive_user |
boolean | Exclusive user access required |
offerings_data.partitions.priority_tier |
integer | Priority tier for scheduling and preemption |
offerings_data.partitions.qos |
string | Quality of Service (QOS) name |
offerings_data.partitions.req_resv |
boolean | Require reservation for job allocation |
offerings_data.roles |
array of objects | |
offerings_data.roles.uuid |
string (uuid) | |
offerings_data.roles.name |
string | |
offerings_data.roles.url |
string (uri) | |
offerings_data.customer |
string (uri) | |
offerings_data.customer_uuid |
string (uuid) | |
offerings_data.customer_name |
string | |
offerings_data.project |
string (uri) | |
offerings_data.project_uuid |
string (uuid) | |
offerings_data.project_name |
string | |
offerings_data.category |
string (uri) | |
offerings_data.category_uuid |
string (uuid) | |
offerings_data.category_title |
string | |
offerings_data.attributes |
object (free-form) | |
offerings_data.options |
any | |
offerings_data.resource_options |
any | |
offerings_data.components |
array of objects | |
offerings_data.components.uuid |
string (uuid) | |
offerings_data.components.billing_type |
string | Enum: fixed, usage, limit, one, few |
offerings_data.components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
offerings_data.components.name |
string | Display name for the measured unit, for example, Floating IP. |
offerings_data.components.description |
string | |
offerings_data.components.measured_unit |
string | Unit of measurement, for example, GB. |
offerings_data.components.unit_factor |
integer | The conversion factor from backend units to measured_unit |
offerings_data.components.limit_period |
any | |
offerings_data.components.limit_amount |
integer | |
offerings_data.components.article_code |
string | |
offerings_data.components.max_value |
integer | |
offerings_data.components.min_value |
integer | |
offerings_data.components.max_available_limit |
integer | |
offerings_data.components.is_boolean |
boolean | |
offerings_data.components.default_limit |
integer | |
offerings_data.components.factor |
integer | |
offerings_data.components.is_builtin |
boolean | |
offerings_data.components.is_prepaid |
boolean | |
offerings_data.components.overage_component |
string (uuid) | |
offerings_data.components.min_prepaid_duration |
integer | |
offerings_data.components.max_prepaid_duration |
integer | |
offerings_data.plugin_options |
any | |
offerings_data.secret_options |
any | |
offerings_data.service_attributes |
object (free-form) | |
offerings_data.state |
any | |
offerings_data.vendor_details |
string | |
offerings_data.getting_started |
string | |
offerings_data.integration_guide |
string | |
offerings_data.thumbnail |
string (uri) | |
offerings_data.order_count |
integer | |
offerings_data.plans |
array of objects | |
offerings_data.plans.url |
string (uri) | |
offerings_data.plans.uuid |
string (uuid) | |
offerings_data.plans.name |
string | |
offerings_data.plans.description |
string | |
offerings_data.plans.article_code |
string | |
offerings_data.plans.max_amount |
integer | Maximum number of plans that could be active. Plan is disabled when maximum amount is reached. |
offerings_data.plans.archived |
boolean | Forbids creation of new resources. |
offerings_data.plans.is_active |
boolean | |
offerings_data.plans.unit_price |
string (decimal) | |
offerings_data.plans.unit |
string | Enum: month, quarter, half_month, day, hour, quantity |
offerings_data.plans.init_price |
number (double) | |
offerings_data.plans.switch_price |
number (double) | |
offerings_data.plans.backend_id |
string | |
offerings_data.plans.organization_groups |
array of objects | |
offerings_data.plans.organization_groups.uuid |
string (uuid) | |
offerings_data.plans.organization_groups.url |
string (uri) | |
offerings_data.plans.organization_groups.name |
string | |
offerings_data.plans.organization_groups.parent_uuid |
string (uuid) | UUID of the parent organization group |
offerings_data.plans.organization_groups.parent_name |
string | Name of the parent organization group |
offerings_data.plans.organization_groups.parent |
string (uri) | |
offerings_data.plans.organization_groups.customers_count |
integer | Number of customers in this organization group |
offerings_data.plans.components |
array of objects | |
offerings_data.plans.components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
offerings_data.plans.components.name |
string | Display name for the measured unit, for example, Floating IP. |
offerings_data.plans.components.measured_unit |
string | Unit of measurement, for example, GB. |
offerings_data.plans.components.amount |
integer | |
offerings_data.plans.components.price |
string (decimal) | |
offerings_data.plans.components.future_price |
string (decimal) | |
offerings_data.plans.components.discount_threshold |
integer | Minimum amount to be eligible for discount. |
offerings_data.plans.components.discount_rate |
integer | Discount rate in percentage. |
offerings_data.plans.prices |
object (free-form) | |
offerings_data.plans.future_prices |
object (free-form) | |
offerings_data.plans.quotas |
object (free-form) | |
offerings_data.plans.resources_count |
integer | |
offerings_data.plans.plan_type |
string | |
offerings_data.plans.minimal_price |
number (double) | |
offerings_data.screenshots |
array of objects | |
offerings_data.screenshots.name |
string | |
offerings_data.screenshots.uuid |
string (uuid) | |
offerings_data.screenshots.description |
string | |
offerings_data.screenshots.image |
string (uri) | |
offerings_data.screenshots.thumbnail |
string (uri) | |
offerings_data.screenshots.created |
string (date-time) | |
offerings_data.type |
string | |
offerings_data.shared |
boolean | Accessible to all customers. |
offerings_data.billable |
boolean | Purchase and usage is invoiced. |
offerings_data.scope |
string | |
offerings_data.scope_uuid |
string (uuid) | |
offerings_data.scope_name |
string (uuid) | |
offerings_data.scope_state |
any | |
offerings_data.scope_error_message |
string | |
offerings_data.files |
array of objects | |
offerings_data.files.name |
string | |
offerings_data.files.created |
string (date-time) | |
offerings_data.files.file |
string (uri) | |
offerings_data.quotas |
array of objects | |
offerings_data.quotas.name |
string | |
offerings_data.quotas.usage |
integer | |
offerings_data.quotas.limit |
integer | |
offerings_data.paused_reason |
string | |
offerings_data.datacite_doi |
string | |
offerings_data.citation_count |
integer | Number of citations of a DOI |
offerings_data.latitude |
number (double) | |
offerings_data.longitude |
number (double) | |
offerings_data.country |
any | Country code (ISO 3166-1 alpha-2) |
offerings_data.backend_id |
string | |
offerings_data.backend_id_rules |
any | Validation rules for resource backend_id: format regex and uniqueness scope. |
offerings_data.organization_groups |
array of objects | |
offerings_data.organization_groups.uuid |
string (uuid) | |
offerings_data.organization_groups.url |
string (uri) | |
offerings_data.organization_groups.name |
string | |
offerings_data.organization_groups.parent_uuid |
string (uuid) | UUID of the parent organization group |
offerings_data.organization_groups.parent_name |
string | Name of the parent organization group |
offerings_data.organization_groups.parent |
string (uri) | |
offerings_data.organization_groups.customers_count |
integer | Number of customers in this organization group |
offerings_data.tags |
array of objects | |
offerings_data.tags.uuid |
string (uuid) | |
offerings_data.tags.name |
string | |
offerings_data.image |
string (uri) | |
offerings_data.total_customers |
integer | |
offerings_data.total_cost |
integer | |
offerings_data.total_cost_estimated |
integer | |
offerings_data.parent_description |
string | |
offerings_data.parent_uuid |
string (uuid) | |
offerings_data.parent_name |
string | |
offerings_data.backend_metadata |
any | |
offerings_data.has_compliance_requirements |
boolean | |
offerings_data.billing_type_classification |
string | Classify offering components by billing type. Returns 'limit_only', 'usage_only', or 'mixed'. |
offerings_data.compliance_checklist |
string (uri) | |
offerings_data.integration_status |
array of objects | |
offerings_data.integration_status.agent_type |
any | |
offerings_data.integration_status.status |
string | |
offerings_data.integration_status.last_request_timestamp |
string (date-time) | |
offerings_data.integration_status.service_name |
string | |
offerings_data.google_calendar_is_public |
boolean | |
offerings_data.google_calendar_link |
string | Get the Google Calendar link for an offering. |
approval_limit |
string (decimal) | The credit limit beyond which requests need to be approved by a local admin. If this is None, then no local approval is required. If this is set to 0, then all requests (including creating the project) need to be approved. |
max_credit_limit |
string (decimal) | The maximum credit limit for any projects created in this class. Any requests beyond this limit are automatically rejected. If this is None, then no maximum limit is set. If this is set to 0, then no projects can be created in this class. |
allocation_units_mapping |
any | The mapping of credits to allocation units, i.e. how many allocation units to award per credit allocated. |
role_mapping |
any | The mapping of role names from the remote portal to role information in this portal for users in projects created in this class. |
role_mapping_data |
object (free-form) | Serialize the role mapping dictionary returned by get_role_mapping() |
Partially update ProjectTemplate object
Partially update ProjectTemplate object
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedProjectTemplateRequest - API Source:
openportal_project_template_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ||
offering |
string | The offering for which this template applies. | |
provider |
string (uri) | ||
portal |
string | ||
key |
string | The key that is used to authenticate requests for this class. | |
customer |
string (uri) | ||
shortname |
string | ||
offerings |
array of string (uri)s | ||
approval_limit |
string (decimal) | The credit limit beyond which requests need to be approved by a local admin. If this is None, then no local approval is required. If this is set to 0, then all requests (including creating the project) need to be approved. | |
max_credit_limit |
string (decimal) | The maximum credit limit for any projects created in this class. Any requests beyond this limit are automatically rejected. If this is None, then no maximum limit is set. If this is set to 0, then no projects can be created in this class. | |
allocation_units_mapping |
any | The mapping of credits to allocation units, i.e. how many allocation units to award per credit allocated. | |
role_mapping |
any | The mapping of role names from the remote portal to role information in this portal for users in projects created in this class. |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
name |
string | |
offering |
string | The offering for which this template applies. |
provider |
string (uri) | |
provider_data |
any | |
portal |
string | |
key |
string | The key that is used to authenticate requests for this class. |
customer |
string (uri) | |
customer_data |
any | |
shortname |
string | |
offerings |
array of string (uri)s | |
offerings_data |
array of objects | |
offerings_data.url |
string (uri) | |
offerings_data.uuid |
string (uuid) | |
offerings_data.created |
string (date-time) | |
offerings_data.name |
string | |
offerings_data.slug |
string | URL-friendly identifier. Only editable by staff users. |
offerings_data.description |
string | |
offerings_data.full_description |
string | |
offerings_data.privacy_policy_link |
string (uri) | |
offerings_data.access_url |
string (uri) | Publicly accessible offering access URL |
offerings_data.endpoints |
array of objects | |
offerings_data.endpoints.uuid |
string (uuid) | |
offerings_data.endpoints.name |
string | |
offerings_data.endpoints.url |
string | URL of the access endpoint |
offerings_data.software_catalogs |
array of objects | |
offerings_data.software_catalogs.uuid |
string (uuid) | |
offerings_data.software_catalogs.catalog |
any | |
offerings_data.software_catalogs.enabled_cpu_family |
any | List of enabled CPU families: ['x86_64', 'aarch64'] |
offerings_data.software_catalogs.enabled_cpu_microarchitectures |
any | List of enabled CPU microarchitectures: ['generic', 'zen3'] |
offerings_data.software_catalogs.package_count |
integer | |
offerings_data.software_catalogs.partition |
any | |
offerings_data.partitions |
array of objects | |
offerings_data.partitions.uuid |
string (uuid) | |
offerings_data.partitions.partition_name |
string | Name of the SLURM partition |
offerings_data.partitions.cpu_bind |
integer | Default task binding policy (SLURM cpu_bind) |
offerings_data.partitions.def_cpu_per_gpu |
integer | Default CPUs allocated per GPU |
offerings_data.partitions.max_cpus_per_node |
integer | Maximum allocated CPUs per node |
offerings_data.partitions.max_cpus_per_socket |
integer | Maximum allocated CPUs per socket |
offerings_data.partitions.def_mem_per_cpu |
integer (int64) | Default memory per CPU in MB |
offerings_data.partitions.def_mem_per_gpu |
integer (int64) | Default memory per GPU in MB |
offerings_data.partitions.def_mem_per_node |
integer (int64) | Default memory per node in MB |
offerings_data.partitions.max_mem_per_cpu |
integer (int64) | Maximum memory per CPU in MB |
offerings_data.partitions.max_mem_per_node |
integer (int64) | Maximum memory per node in MB |
offerings_data.partitions.default_time |
integer | Default time limit in minutes |
offerings_data.partitions.max_time |
integer | Maximum time limit in minutes |
offerings_data.partitions.grace_time |
integer | Preemption grace time in seconds |
offerings_data.partitions.max_nodes |
integer | Maximum nodes per job |
offerings_data.partitions.min_nodes |
integer | Minimum nodes per job |
offerings_data.partitions.exclusive_topo |
boolean | Exclusive topology access required |
offerings_data.partitions.exclusive_user |
boolean | Exclusive user access required |
offerings_data.partitions.priority_tier |
integer | Priority tier for scheduling and preemption |
offerings_data.partitions.qos |
string | Quality of Service (QOS) name |
offerings_data.partitions.req_resv |
boolean | Require reservation for job allocation |
offerings_data.roles |
array of objects | |
offerings_data.roles.uuid |
string (uuid) | |
offerings_data.roles.name |
string | |
offerings_data.roles.url |
string (uri) | |
offerings_data.customer |
string (uri) | |
offerings_data.customer_uuid |
string (uuid) | |
offerings_data.customer_name |
string | |
offerings_data.project |
string (uri) | |
offerings_data.project_uuid |
string (uuid) | |
offerings_data.project_name |
string | |
offerings_data.category |
string (uri) | |
offerings_data.category_uuid |
string (uuid) | |
offerings_data.category_title |
string | |
offerings_data.attributes |
object (free-form) | |
offerings_data.options |
any | |
offerings_data.resource_options |
any | |
offerings_data.components |
array of objects | |
offerings_data.components.uuid |
string (uuid) | |
offerings_data.components.billing_type |
string | Enum: fixed, usage, limit, one, few |
offerings_data.components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
offerings_data.components.name |
string | Display name for the measured unit, for example, Floating IP. |
offerings_data.components.description |
string | |
offerings_data.components.measured_unit |
string | Unit of measurement, for example, GB. |
offerings_data.components.unit_factor |
integer | The conversion factor from backend units to measured_unit |
offerings_data.components.limit_period |
any | |
offerings_data.components.limit_amount |
integer | |
offerings_data.components.article_code |
string | |
offerings_data.components.max_value |
integer | |
offerings_data.components.min_value |
integer | |
offerings_data.components.max_available_limit |
integer | |
offerings_data.components.is_boolean |
boolean | |
offerings_data.components.default_limit |
integer | |
offerings_data.components.factor |
integer | |
offerings_data.components.is_builtin |
boolean | |
offerings_data.components.is_prepaid |
boolean | |
offerings_data.components.overage_component |
string (uuid) | |
offerings_data.components.min_prepaid_duration |
integer | |
offerings_data.components.max_prepaid_duration |
integer | |
offerings_data.plugin_options |
any | |
offerings_data.secret_options |
any | |
offerings_data.service_attributes |
object (free-form) | |
offerings_data.state |
any | |
offerings_data.vendor_details |
string | |
offerings_data.getting_started |
string | |
offerings_data.integration_guide |
string | |
offerings_data.thumbnail |
string (uri) | |
offerings_data.order_count |
integer | |
offerings_data.plans |
array of objects | |
offerings_data.plans.url |
string (uri) | |
offerings_data.plans.uuid |
string (uuid) | |
offerings_data.plans.name |
string | |
offerings_data.plans.description |
string | |
offerings_data.plans.article_code |
string | |
offerings_data.plans.max_amount |
integer | Maximum number of plans that could be active. Plan is disabled when maximum amount is reached. |
offerings_data.plans.archived |
boolean | Forbids creation of new resources. |
offerings_data.plans.is_active |
boolean | |
offerings_data.plans.unit_price |
string (decimal) | |
offerings_data.plans.unit |
string | Enum: month, quarter, half_month, day, hour, quantity |
offerings_data.plans.init_price |
number (double) | |
offerings_data.plans.switch_price |
number (double) | |
offerings_data.plans.backend_id |
string | |
offerings_data.plans.organization_groups |
array of objects | |
offerings_data.plans.organization_groups.uuid |
string (uuid) | |
offerings_data.plans.organization_groups.url |
string (uri) | |
offerings_data.plans.organization_groups.name |
string | |
offerings_data.plans.organization_groups.parent_uuid |
string (uuid) | UUID of the parent organization group |
offerings_data.plans.organization_groups.parent_name |
string | Name of the parent organization group |
offerings_data.plans.organization_groups.parent |
string (uri) | |
offerings_data.plans.organization_groups.customers_count |
integer | Number of customers in this organization group |
offerings_data.plans.components |
array of objects | |
offerings_data.plans.components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
offerings_data.plans.components.name |
string | Display name for the measured unit, for example, Floating IP. |
offerings_data.plans.components.measured_unit |
string | Unit of measurement, for example, GB. |
offerings_data.plans.components.amount |
integer | |
offerings_data.plans.components.price |
string (decimal) | |
offerings_data.plans.components.future_price |
string (decimal) | |
offerings_data.plans.components.discount_threshold |
integer | Minimum amount to be eligible for discount. |
offerings_data.plans.components.discount_rate |
integer | Discount rate in percentage. |
offerings_data.plans.prices |
object (free-form) | |
offerings_data.plans.future_prices |
object (free-form) | |
offerings_data.plans.quotas |
object (free-form) | |
offerings_data.plans.resources_count |
integer | |
offerings_data.plans.plan_type |
string | |
offerings_data.plans.minimal_price |
number (double) | |
offerings_data.screenshots |
array of objects | |
offerings_data.screenshots.name |
string | |
offerings_data.screenshots.uuid |
string (uuid) | |
offerings_data.screenshots.description |
string | |
offerings_data.screenshots.image |
string (uri) | |
offerings_data.screenshots.thumbnail |
string (uri) | |
offerings_data.screenshots.created |
string (date-time) | |
offerings_data.type |
string | |
offerings_data.shared |
boolean | Accessible to all customers. |
offerings_data.billable |
boolean | Purchase and usage is invoiced. |
offerings_data.scope |
string | |
offerings_data.scope_uuid |
string (uuid) | |
offerings_data.scope_name |
string (uuid) | |
offerings_data.scope_state |
any | |
offerings_data.scope_error_message |
string | |
offerings_data.files |
array of objects | |
offerings_data.files.name |
string | |
offerings_data.files.created |
string (date-time) | |
offerings_data.files.file |
string (uri) | |
offerings_data.quotas |
array of objects | |
offerings_data.quotas.name |
string | |
offerings_data.quotas.usage |
integer | |
offerings_data.quotas.limit |
integer | |
offerings_data.paused_reason |
string | |
offerings_data.datacite_doi |
string | |
offerings_data.citation_count |
integer | Number of citations of a DOI |
offerings_data.latitude |
number (double) | |
offerings_data.longitude |
number (double) | |
offerings_data.country |
any | Country code (ISO 3166-1 alpha-2) |
offerings_data.backend_id |
string | |
offerings_data.backend_id_rules |
any | Validation rules for resource backend_id: format regex and uniqueness scope. |
offerings_data.organization_groups |
array of objects | |
offerings_data.organization_groups.uuid |
string (uuid) | |
offerings_data.organization_groups.url |
string (uri) | |
offerings_data.organization_groups.name |
string | |
offerings_data.organization_groups.parent_uuid |
string (uuid) | UUID of the parent organization group |
offerings_data.organization_groups.parent_name |
string | Name of the parent organization group |
offerings_data.organization_groups.parent |
string (uri) | |
offerings_data.organization_groups.customers_count |
integer | Number of customers in this organization group |
offerings_data.tags |
array of objects | |
offerings_data.tags.uuid |
string (uuid) | |
offerings_data.tags.name |
string | |
offerings_data.image |
string (uri) | |
offerings_data.total_customers |
integer | |
offerings_data.total_cost |
integer | |
offerings_data.total_cost_estimated |
integer | |
offerings_data.parent_description |
string | |
offerings_data.parent_uuid |
string (uuid) | |
offerings_data.parent_name |
string | |
offerings_data.backend_metadata |
any | |
offerings_data.has_compliance_requirements |
boolean | |
offerings_data.billing_type_classification |
string | Classify offering components by billing type. Returns 'limit_only', 'usage_only', or 'mixed'. |
offerings_data.compliance_checklist |
string (uri) | |
offerings_data.integration_status |
array of objects | |
offerings_data.integration_status.agent_type |
any | |
offerings_data.integration_status.status |
string | |
offerings_data.integration_status.last_request_timestamp |
string (date-time) | |
offerings_data.integration_status.service_name |
string | |
offerings_data.google_calendar_is_public |
boolean | |
offerings_data.google_calendar_link |
string | Get the Google Calendar link for an offering. |
approval_limit |
string (decimal) | The credit limit beyond which requests need to be approved by a local admin. If this is None, then no local approval is required. If this is set to 0, then all requests (including creating the project) need to be approved. |
max_credit_limit |
string (decimal) | The maximum credit limit for any projects created in this class. Any requests beyond this limit are automatically rejected. If this is None, then no maximum limit is set. If this is set to 0, then no projects can be created in this class. |
allocation_units_mapping |
any | The mapping of credits to allocation units, i.e. how many allocation units to award per credit allocated. |
role_mapping |
any | The mapping of role names from the remote portal to role information in this portal for users in projects created in this class. |
role_mapping_data |
object (free-form) | Serialize the role mapping dictionary returned by get_role_mapping() |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openportal_project_template_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
Delete ProjectTemplate object
Delete ProjectTemplate object
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openportal_project_template_delete_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Openportal Projectinfo
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/openportal-projectinfo/ |
List Openportal Projectinfo |
| GET | /api/openportal-projectinfo/{project}/ |
Retrieve |
| POST | /api/openportal-projectinfo/ |
Create |
| PUT | /api/openportal-projectinfo/{project}/ |
Update |
| PATCH | /api/openportal-projectinfo/{project}/ |
Partial Update |
| DELETE | /api/openportal-projectinfo/{project}/ |
Delete |
| Other Actions | ||
| PUT | /api/openportal-projectinfo/{project}/set_allowed_destinations/ |
Set allowed destinations |
| PUT | /api/openportal-projectinfo/{project}/set_shortname/ |
Set shortname |
Core CRUD
List Openportal Projectinfo
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
openportal_projectinfo_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
project |
string (uri) | |
project_uuid |
string (uuid) |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
project |
string (uri) | |
shortname |
string | A short, unique name for the project. It will be used to form the local username of any users in the project on any systems. Should only contain lower-case letters and digits and must start with a letter. |
allowed_destinations |
string | A comma-separated list of allowable destinations of instances that can be attached to this project. For example, a project may only allow 'brics.aip1.*', meaning that only instances that start with 'brics.aip1.' can be attached to this project. |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openportal_projectinfo_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
project |
integer (uri) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
project |
string (uri) | |
shortname |
string | A short, unique name for the project. It will be used to form the local username of any users in the project on any systems. Should only contain lower-case letters and digits and must start with a letter. |
allowed_destinations |
string | A comma-separated list of allowable destinations of instances that can be attached to this project. For example, a project may only allow 'brics.aip1.*', meaning that only instances that start with 'brics.aip1.' can be attached to this project. |
Create
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
- Model Source:
ProjectInfoRequest - API Source:
openportal_projectinfo_create
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Field | Type | Required | Description |
|---|---|---|---|
project |
string (uri) | ✓ | |
shortname |
string | A short, unique name for the project. It will be used to form the local username of any users in the project on any systems. Should only contain lower-case letters and digits and must start with a letter. | |
allowed_destinations |
string | A comma-separated list of allowable destinations of instances that can be attached to this project. For example, a project may only allow 'brics.aip1.*', meaning that only instances that start with 'brics.aip1.' can be attached to this project. |
201 -
| Field | Type | Description |
|---|---|---|
project |
string (uri) | |
shortname |
string | A short, unique name for the project. It will be used to form the local username of any users in the project on any systems. Should only contain lower-case letters and digits and must start with a letter. |
allowed_destinations |
string | A comma-separated list of allowable destinations of instances that can be attached to this project. For example, a project may only allow 'brics.aip1.*', meaning that only instances that start with 'brics.aip1.' can be attached to this project. |
Update
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
ProjectInfoRequest - API Source:
openportal_projectinfo_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
project |
integer (uri) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
project |
string (uri) | ✓ | |
shortname |
string | A short, unique name for the project. It will be used to form the local username of any users in the project on any systems. Should only contain lower-case letters and digits and must start with a letter. | |
allowed_destinations |
string | A comma-separated list of allowable destinations of instances that can be attached to this project. For example, a project may only allow 'brics.aip1.*', meaning that only instances that start with 'brics.aip1.' can be attached to this project. |
200 -
| Field | Type | Description |
|---|---|---|
project |
string (uri) | |
shortname |
string | A short, unique name for the project. It will be used to form the local username of any users in the project on any systems. Should only contain lower-case letters and digits and must start with a letter. |
allowed_destinations |
string | A comma-separated list of allowable destinations of instances that can be attached to this project. For example, a project may only allow 'brics.aip1.*', meaning that only instances that start with 'brics.aip1.' can be attached to this project. |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedProjectInfoRequest - API Source:
openportal_projectinfo_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
project |
integer (uri) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
project |
string (uri) | ||
shortname |
string | A short, unique name for the project. It will be used to form the local username of any users in the project on any systems. Should only contain lower-case letters and digits and must start with a letter. | |
allowed_destinations |
string | A comma-separated list of allowable destinations of instances that can be attached to this project. For example, a project may only allow 'brics.aip1.*', meaning that only instances that start with 'brics.aip1.' can be attached to this project. |
200 -
| Field | Type | Description |
|---|---|---|
project |
string (uri) | |
shortname |
string | A short, unique name for the project. It will be used to form the local username of any users in the project on any systems. Should only contain lower-case letters and digits and must start with a letter. |
allowed_destinations |
string | A comma-separated list of allowable destinations of instances that can be attached to this project. For example, a project may only allow 'brics.aip1.*', meaning that only instances that start with 'brics.aip1.' can be attached to this project. |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openportal_projectinfo_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
project |
integer (uri) | ✓ |
204 - No response body
Other Actions
Set allowed destinations
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
ProjectInfoRequest - API Source:
openportal_projectinfo_set_allowed_destinations_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
project |
integer (uri) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
project |
string (uri) | ✓ | |
shortname |
string | A short, unique name for the project. It will be used to form the local username of any users in the project on any systems. Should only contain lower-case letters and digits and must start with a letter. | |
allowed_destinations |
string | A comma-separated list of allowable destinations of instances that can be attached to this project. For example, a project may only allow 'brics.aip1.*', meaning that only instances that start with 'brics.aip1.' can be attached to this project. |
200 -
| Field | Type | Description |
|---|---|---|
project |
string (uri) | |
shortname |
string | A short, unique name for the project. It will be used to form the local username of any users in the project on any systems. Should only contain lower-case letters and digits and must start with a letter. |
allowed_destinations |
string | A comma-separated list of allowable destinations of instances that can be attached to this project. For example, a project may only allow 'brics.aip1.*', meaning that only instances that start with 'brics.aip1.' can be attached to this project. |
Set shortname
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
ProjectInfoRequest - API Source:
openportal_projectinfo_set_shortname_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
project |
integer (uri) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
project |
string (uri) | ✓ | |
shortname |
string | A short, unique name for the project. It will be used to form the local username of any users in the project on any systems. Should only contain lower-case letters and digits and must start with a letter. | |
allowed_destinations |
string | A comma-separated list of allowable destinations of instances that can be attached to this project. For example, a project may only allow 'brics.aip1.*', meaning that only instances that start with 'brics.aip1.' can be attached to this project. |
200 -
| Field | Type | Description |
|---|---|---|
project |
string (uri) | |
shortname |
string | A short, unique name for the project. It will be used to form the local username of any users in the project on any systems. Should only contain lower-case letters and digits and must start with a letter. |
allowed_destinations |
string | A comma-separated list of allowable destinations of instances that can be attached to this project. For example, a project may only allow 'brics.aip1.*', meaning that only instances that start with 'brics.aip1.' can be attached to this project. |
Openportal Remote Allocations
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/openportal-remote-allocations/ |
List Openportal Remote Allocations |
| GET | /api/openportal-remote-allocations/{uuid}/ |
Retrieve |
| POST | /api/openportal-remote-allocations/ |
Create |
| POST | /api/openportal-remote-allocations/{uuid}/pull/ |
Synchronize resource state |
| POST | /api/openportal-remote-allocations/{uuid}/unlink/ |
Unlink resource |
| PUT | /api/openportal-remote-allocations/{uuid}/ |
Update |
| PATCH | /api/openportal-remote-allocations/{uuid}/ |
Partial Update |
| DELETE | /api/openportal-remote-allocations/{uuid}/ |
Delete |
| Other Actions | ||
| POST | /api/openportal-remote-allocations/{uuid}/set_erred/ |
Mark resource as ERRED |
| POST | /api/openportal-remote-allocations/{uuid}/set_limits/ |
Set limits |
| POST | /api/openportal-remote-allocations/{uuid}/set_ok/ |
Mark resource as OK |
Core CRUD
List Openportal Remote Allocations
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- Model Source:
CoreStates - Model Source:
RemoteAllocationFieldEnum - API Source:
openportal_remote_allocations_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
backend_id |
string | Backend ID |
can_manage |
boolean | Can manage |
customer |
string (uuid) | Customer UUID |
customer_abbreviation |
string | Customer abbreviation |
customer_name |
string | Customer name |
customer_native_name |
string | Customer native name |
customer_uuid |
string (uuid) | Customer UUID |
description |
string | Description |
external_ip |
string | External IP |
field |
array | |
is_active |
boolean | |
name |
string | Name |
name_exact |
string | Name (exact) |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
project |
string (uuid) | Project UUID |
project_name |
string | Project name |
project_uuid |
string (uuid) | Project UUID |
service_settings_name |
string | Service settings name |
service_settings_uuid |
string (uuid) | Service settings UUID |
state |
array | State |
uuid |
string (uuid) | UUID |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
node_limit |
integer (int64) | |
remote_project_identifier |
string | The identifier of the project in the remote OpenPortal instance. |
node_usage |
string (decimal) | |
is_active |
boolean | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
RemoteAllocationFieldEnum - API Source:
openportal_remote_allocations_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
node_limit |
integer (int64) | |
remote_project_identifier |
string | The identifier of the project in the remote OpenPortal instance. |
node_usage |
string (decimal) | |
is_active |
boolean | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Create
1 2 3 4 5 6 7 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
RemoteAllocationRequest - API Source:
openportal_remote_allocations_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ✓ | |
description |
string | ||
service_settings |
string (uri) | ✓ | |
project |
string (uri) | ✓ | |
node_limit |
integer (int64) | ||
remote_project_identifier |
string | The identifier of the project in the remote OpenPortal instance. |
201 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
node_limit |
integer (int64) | |
remote_project_identifier |
string | The identifier of the project in the remote OpenPortal instance. |
node_usage |
string (decimal) | |
is_active |
boolean | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Synchronize resource state
Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openportal_remote_allocations_pull
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
202 -
| Field | Type |
|---|---|
detail |
string |
409 -
| Field | Type |
|---|---|
detail |
string |
Unlink resource
Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openportal_remote_allocations_unlink
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Update
1 2 3 4 5 6 7 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | |
- Model Source:
RemoteAllocationRequest - API Source:
openportal_remote_allocations_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ✓ | |
description |
string | ||
service_settings |
string (uri) | ✓ | |
project |
string (uri) | ✓ | |
node_limit |
integer (int64) | ||
remote_project_identifier |
string | The identifier of the project in the remote OpenPortal instance. |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
node_limit |
integer (int64) | |
remote_project_identifier |
string | The identifier of the project in the remote OpenPortal instance. |
node_usage |
string (decimal) | |
is_active |
boolean | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedRemoteAllocationRequest - API Source:
openportal_remote_allocations_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ||
description |
string | ||
node_limit |
integer (int64) | ||
remote_project_identifier |
string | The identifier of the project in the remote OpenPortal instance. |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
node_limit |
integer (int64) | |
remote_project_identifier |
string | The identifier of the project in the remote OpenPortal instance. |
node_usage |
string (decimal) | |
is_active |
boolean | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openportal_remote_allocations_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
Mark resource as ERRED
Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
SetErredRequest - API Source:
openportal_remote_allocations_set_erred
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
error_message |
string | |
error_traceback |
string |
200 -
| Field | Type |
|---|---|
detail |
string |
Set limits
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
RemoteAllocationSetLimitsRequest - API Source:
openportal_remote_allocations_set_limits
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
node_limit |
integer | ✓ |
200 -
| Field | Type |
|---|---|
node_limit |
integer |
Mark resource as OK
Manually transition the resource to OK state and clear error fields. Staff-only operation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openportal_remote_allocations_set_ok
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
detail |
string |
Openportal Remote Associations
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/openportal-remote-associations/ |
List Openportal Remote Associations |
| GET | /api/openportal-remote-associations/{uuid}/ |
Retrieve |
List Openportal Remote Associations
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
openportal_remote_associations_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
allocation |
string (uri) | |
allocation_uuid |
string (uuid) | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
uuid |
string (uuid) |
allocation |
string (uri) |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openportal_remote_associations_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
allocation |
string (uri) |
Openportal Unmanaged Projects
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/openportal-unmanaged-projects/ |
List projects |
| GET | /api/openportal-unmanaged-projects/{uuid}/ |
Retrieve project details |
| POST | /api/openportal-unmanaged-projects/ |
Create a new project |
| PUT | /api/openportal-unmanaged-projects/{uuid}/ |
Update project details |
| PATCH | /api/openportal-unmanaged-projects/{uuid}/ |
Partially update project details |
| DELETE | /api/openportal-unmanaged-projects/{uuid}/ |
Delete a project |
| Permissions & Users | ||
| GET | /api/openportal-unmanaged-projects/{uuid}/list_users/ |
List users and their roles in a scope |
| POST | /api/openportal-unmanaged-projects/{uuid}/add_user/ |
Grant a role to a user |
| POST | /api/openportal-unmanaged-projects/{uuid}/delete_user/ |
Revoke a role from a user |
| POST | /api/openportal-unmanaged-projects/{uuid}/update_user/ |
Update a user's role expiration |
| Other Actions | ||
| GET | /api/openportal-unmanaged-projects/{uuid}/checklist/ |
Get checklist with questions and existing answers |
| GET | /api/openportal-unmanaged-projects/checklist-template/ |
Get checklist template for creating new objects |
| GET | /api/openportal-unmanaged-projects/{uuid}/completion_status/ |
Get checklist completion status |
| GET | /api/openportal-unmanaged-projects/{uuid}/stats/ |
Get project resource usage statistics |
| POST | /api/openportal-unmanaged-projects/{uuid}/move_project/ |
Move project to another customer |
| POST | /api/openportal-unmanaged-projects/{uuid}/recover/ |
Recover a soft-deleted project |
| POST | /api/openportal-unmanaged-projects/{uuid}/submit_answers/ |
Submit checklist answers |
Core CRUD
List projects
Retrieve a list of projects. The list is filtered based on the user's permissions. By default, only active projects are shown.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- Model Source:
MarketplaceProviderCustomerProjectOEnum - Model Source:
ProjectFieldEnum - API Source:
openportal_unmanaged_projects_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
accounting_is_running |
boolean | Filter by whether accounting is running. |
backend_id |
string | |
can_admin |
boolean | Return a list of projects where current user is admin. |
can_manage |
boolean | Return a list of projects where current user is manager or a customer owner. |
conceal_finished_projects |
boolean | Conceal finished projects |
created |
string (date-time) | Created after |
customer |
array | Multiple values may be separated by commas. |
customer_abbreviation |
string | Customer abbreviation |
customer_name |
string | Customer name |
customer_native_name |
string | Customer native name |
description |
string | Description |
field |
array | |
include_terminated |
boolean | Include soft-deleted (terminated) projects. Only available to staff and support users, or users with organizational roles who can see their terminated projects. |
is_removed |
boolean | Is removed |
modified |
string (date-time) | Modified after |
name |
string | Name |
name_exact |
string | Name (exact) |
o |
array | Ordering |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
query |
string | Filter by name, slug, UUID, backend ID or resource effective ID |
slug |
string | Slug |
user_uuid |
string (uuid) | Filter by user UUID. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
slug |
string | URL-friendly identifier. Only editable by staff users. |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_slug |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
description |
string | Project description (HTML content will be sanitized) |
customer_display_billing_info_in_projects |
boolean | |
created |
string (date-time) | |
type |
string (uri) | |
type_name |
string | |
type_uuid |
string (uuid) | |
backend_id |
string | |
start_date |
string (date) | Project start date. Cannot be edited after the start date has arrived. |
end_date |
string (date) | Project end date. Setting this field requires DELETE_PROJECT permission. |
end_date_requested_by |
string (uri) | |
oecd_fos_2007_code |
any | |
oecd_fos_2007_label |
string | Human-readable label for the OECD FOS 2007 classification code |
is_industry |
boolean | |
image |
string (uri) | |
resources_count |
integer | Number of active resources in this project |
max_service_accounts |
integer | Maximum number of service accounts allowed |
kind |
any | |
is_removed |
boolean | |
termination_metadata |
any | Metadata about project termination (read-only) |
staff_notes |
string | Internal notes visible only to staff and support users (HTML content will be sanitized) |
grace_period_days |
integer | Number of extra days after project end date before resources are terminated. Overrides customer-level setting. |
user_email_patterns |
any | |
user_affiliations |
any | |
user_identity_sources |
any | List of allowed identity sources (identity providers). |
project_credit |
number (double) | |
marketplace_resource_count |
object (free-form) | |
billing_price_estimate |
any |
Retrieve project details
Fetch the details of a specific project by its UUID. Users can access details of terminated projects they previously had access to.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
ProjectFieldEnum - API Source:
openportal_unmanaged_projects_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
slug |
string | URL-friendly identifier. Only editable by staff users. |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_slug |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
description |
string | Project description (HTML content will be sanitized) |
customer_display_billing_info_in_projects |
boolean | |
created |
string (date-time) | |
type |
string (uri) | |
type_name |
string | |
type_uuid |
string (uuid) | |
backend_id |
string | |
start_date |
string (date) | Project start date. Cannot be edited after the start date has arrived. |
end_date |
string (date) | Project end date. Setting this field requires DELETE_PROJECT permission. |
end_date_requested_by |
string (uri) | |
oecd_fos_2007_code |
any | |
oecd_fos_2007_label |
string | Human-readable label for the OECD FOS 2007 classification code |
is_industry |
boolean | |
image |
string (uri) | |
resources_count |
integer | Number of active resources in this project |
max_service_accounts |
integer | Maximum number of service accounts allowed |
kind |
any | |
is_removed |
boolean | |
termination_metadata |
any | Metadata about project termination (read-only) |
staff_notes |
string | Internal notes visible only to staff and support users (HTML content will be sanitized) |
grace_period_days |
integer | Number of extra days after project end date before resources are terminated. Overrides customer-level setting. |
user_email_patterns |
any | |
user_affiliations |
any | |
user_identity_sources |
any | List of allowed identity sources (identity providers). |
project_credit |
number (double) | |
marketplace_resource_count |
object (free-form) | |
billing_price_estimate |
any |
Create a new project
A new project can be created by users with staff privilege (is_staff=True) or customer owners. Project resource quota is optional.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
ProjectRequest - API Source:
openportal_unmanaged_projects_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ✓ | |
slug |
string | URL-friendly identifier. Only editable by staff users. | |
customer |
string (uri) | ✓ | |
description |
string | Project description (HTML content will be sanitized) | |
type |
string (uri) | ||
backend_id |
string | ||
start_date |
string (date) | Project start date. Cannot be edited after the start date has arrived. | |
end_date |
string (date) | Project end date. Setting this field requires DELETE_PROJECT permission. | |
oecd_fos_2007_code |
any | ||
is_industry |
boolean | ||
image |
string (binary) | ||
kind |
any | ||
staff_notes |
string | Internal notes visible only to staff and support users (HTML content will be sanitized) | |
grace_period_days |
integer | Number of extra days after project end date before resources are terminated. Overrides customer-level setting. | |
user_email_patterns |
any | ||
user_affiliations |
any | ||
user_identity_sources |
any | List of allowed identity sources (identity providers). |
201 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
slug |
string | URL-friendly identifier. Only editable by staff users. |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_slug |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
description |
string | Project description (HTML content will be sanitized) |
customer_display_billing_info_in_projects |
boolean | |
created |
string (date-time) | |
type |
string (uri) | |
type_name |
string | |
type_uuid |
string (uuid) | |
backend_id |
string | |
start_date |
string (date) | Project start date. Cannot be edited after the start date has arrived. |
end_date |
string (date) | Project end date. Setting this field requires DELETE_PROJECT permission. |
end_date_requested_by |
string (uri) | |
oecd_fos_2007_code |
any | |
oecd_fos_2007_label |
string | Human-readable label for the OECD FOS 2007 classification code |
is_industry |
boolean | |
image |
string (uri) | |
resources_count |
integer | Number of active resources in this project |
max_service_accounts |
integer | Maximum number of service accounts allowed |
kind |
any | |
is_removed |
boolean | |
termination_metadata |
any | Metadata about project termination (read-only) |
staff_notes |
string | Internal notes visible only to staff and support users (HTML content will be sanitized) |
grace_period_days |
integer | Number of extra days after project end date before resources are terminated. Overrides customer-level setting. |
user_email_patterns |
any | |
user_affiliations |
any | |
user_identity_sources |
any | List of allowed identity sources (identity providers). |
project_credit |
number (double) | |
marketplace_resource_count |
object (free-form) | |
billing_price_estimate |
any |
Update project details
Update the details of a project. Requires project administrator or customer owner permissions.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
ProjectRequest - API Source:
openportal_unmanaged_projects_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ✓ | |
slug |
string | URL-friendly identifier. Only editable by staff users. | |
customer |
string (uri) | ✓ | |
description |
string | Project description (HTML content will be sanitized) | |
type |
string (uri) | ||
backend_id |
string | ||
start_date |
string (date) | Project start date. Cannot be edited after the start date has arrived. | |
end_date |
string (date) | Project end date. Setting this field requires DELETE_PROJECT permission. | |
oecd_fos_2007_code |
any | ||
is_industry |
boolean | ||
image |
string (binary) | ||
kind |
any | ||
staff_notes |
string | Internal notes visible only to staff and support users (HTML content will be sanitized) | |
grace_period_days |
integer | Number of extra days after project end date before resources are terminated. Overrides customer-level setting. | |
user_email_patterns |
any | ||
user_affiliations |
any | ||
user_identity_sources |
any | List of allowed identity sources (identity providers). |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
slug |
string | URL-friendly identifier. Only editable by staff users. |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_slug |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
description |
string | Project description (HTML content will be sanitized) |
customer_display_billing_info_in_projects |
boolean | |
created |
string (date-time) | |
type |
string (uri) | |
type_name |
string | |
type_uuid |
string (uuid) | |
backend_id |
string | |
start_date |
string (date) | Project start date. Cannot be edited after the start date has arrived. |
end_date |
string (date) | Project end date. Setting this field requires DELETE_PROJECT permission. |
end_date_requested_by |
string (uri) | |
oecd_fos_2007_code |
any | |
oecd_fos_2007_label |
string | Human-readable label for the OECD FOS 2007 classification code |
is_industry |
boolean | |
image |
string (uri) | |
resources_count |
integer | Number of active resources in this project |
max_service_accounts |
integer | Maximum number of service accounts allowed |
kind |
any | |
is_removed |
boolean | |
termination_metadata |
any | Metadata about project termination (read-only) |
staff_notes |
string | Internal notes visible only to staff and support users (HTML content will be sanitized) |
grace_period_days |
integer | Number of extra days after project end date before resources are terminated. Overrides customer-level setting. |
user_email_patterns |
any | |
user_affiliations |
any | |
user_identity_sources |
any | List of allowed identity sources (identity providers). |
project_credit |
number (double) | |
marketplace_resource_count |
object (free-form) | |
billing_price_estimate |
any |
Partially update project details
Partially update the details of a project. Requires project administrator or customer owner permissions.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedProjectRequest - API Source:
openportal_unmanaged_projects_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ||
slug |
string | URL-friendly identifier. Only editable by staff users. | |
customer |
string (uri) | ||
description |
string | Project description (HTML content will be sanitized) | |
type |
string (uri) | ||
backend_id |
string | ||
start_date |
string (date) | Project start date. Cannot be edited after the start date has arrived. | |
end_date |
string (date) | Project end date. Setting this field requires DELETE_PROJECT permission. | |
oecd_fos_2007_code |
any | ||
is_industry |
boolean | ||
image |
string (binary) | ||
kind |
any | ||
staff_notes |
string | Internal notes visible only to staff and support users (HTML content will be sanitized) | |
grace_period_days |
integer | Number of extra days after project end date before resources are terminated. Overrides customer-level setting. | |
user_email_patterns |
any | ||
user_affiliations |
any | ||
user_identity_sources |
any | List of allowed identity sources (identity providers). |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
slug |
string | URL-friendly identifier. Only editable by staff users. |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_slug |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
description |
string | Project description (HTML content will be sanitized) |
customer_display_billing_info_in_projects |
boolean | |
created |
string (date-time) | |
type |
string (uri) | |
type_name |
string | |
type_uuid |
string (uuid) | |
backend_id |
string | |
start_date |
string (date) | Project start date. Cannot be edited after the start date has arrived. |
end_date |
string (date) | Project end date. Setting this field requires DELETE_PROJECT permission. |
end_date_requested_by |
string (uri) | |
oecd_fos_2007_code |
any | |
oecd_fos_2007_label |
string | Human-readable label for the OECD FOS 2007 classification code |
is_industry |
boolean | |
image |
string (uri) | |
resources_count |
integer | Number of active resources in this project |
max_service_accounts |
integer | Maximum number of service accounts allowed |
kind |
any | |
is_removed |
boolean | |
termination_metadata |
any | Metadata about project termination (read-only) |
staff_notes |
string | Internal notes visible only to staff and support users (HTML content will be sanitized) |
grace_period_days |
integer | Number of extra days after project end date before resources are terminated. Overrides customer-level setting. |
user_email_patterns |
any | |
user_affiliations |
any | |
user_identity_sources |
any | List of allowed identity sources (identity providers). |
project_credit |
number (double) | |
marketplace_resource_count |
object (free-form) | |
billing_price_estimate |
any |
Delete a project
Delete a project. If the project has any active resources, the deletion request will fail with a 409 Conflict response. This action performs a soft-delete, and the project can be recovered later.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openportal_unmanaged_projects_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Permissions & Users
List users and their roles in a scope
Retrieves a list of users who have a role within a specific scope (e.g., a project or an organization). The list can be filtered by user details or role.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
- Model Source:
UserRoleDetailsFieldEnum - Model Source:
UserRoleDetailsOEnum - API Source:
openportal_unmanaged_projects_list_users_list
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
field |
array | Fields to include in response |
full_name |
string | User full name |
native_name |
string | User native name |
o |
array | Ordering fields |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
role |
string (uuid) | Role UUID or name |
search_string |
string | Search string for user |
user |
string (uuid) | User UUID |
user_slug |
string | User slug |
user_url |
string | User URL |
username |
string | User username |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
created |
string (date-time) | |
expiration_time |
string (date-time) | |
role_name |
string | |
role_uuid |
string (uuid) | |
user_email |
string (email) | |
user_full_name |
string | |
user_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
user_uuid |
string (uuid) | |
user_image |
string (uri) | |
created_by_full_name |
string | |
created_by_uuid |
string (uuid) |
Grant a role to a user
Assigns a specific role to a user within the current scope. An optional expiration time for the role can be set.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
UserRoleCreateRequest - API Source:
openportal_unmanaged_projects_add_user
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
role |
string | ✓ |
user |
string (uuid) | ✓ |
expiration_time |
string (date-time) |
201 -
| Field | Type |
|---|---|
expiration_time |
string (date-time) |
400 - Validation error, for example when trying to add a user to a terminated project.
Revoke a role from a user
Removes a specific role from a user within the current scope. This effectively revokes their permissions associated with that role.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
UserRoleDeleteRequest - API Source:
openportal_unmanaged_projects_delete_user
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
role |
string | ✓ |
user |
string (uuid) | ✓ |
expiration_time |
string (date-time) |
200 - Role revoked successfully.
Update a user's role expiration
Updates the expiration time for a user's existing role in the current scope. This is useful for extending or shortening the duration of a permission. To make a role permanent, set expiration_time to null.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
UserRoleUpdateRequest - API Source:
openportal_unmanaged_projects_update_user
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
role |
string | ✓ |
user |
string (uuid) | ✓ |
expiration_time |
string (date-time) |
200 -
| Field | Type |
|---|---|
expiration_time |
string (date-time) |
Other Actions
Get checklist with questions and existing answers
Get checklist with questions and existing answers.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openportal_unmanaged_projects_checklist_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
include_all |
boolean | If true, returns all questions including hidden ones (for dynamic form visibility). Default: false. |
200 -
| Field | Type | Description |
|---|---|---|
checklist |
object (free-form) | |
completion |
object | |
completion.uuid |
string (uuid) | |
completion.is_completed |
boolean | Whether all required questions have been answered |
completion.completion_percentage |
number (double) | |
completion.unanswered_required_questions |
array of anys | |
completion.checklist_name |
string | |
completion.checklist_description |
string | |
completion.created |
string (date-time) | |
completion.modified |
string (date-time) | |
questions |
array of objects | |
questions.uuid |
string (uuid) | |
questions.description |
string | |
questions.user_guidance |
string | |
questions.question_type |
any | Type of question and expected answer format |
questions.required |
boolean | |
questions.order |
integer | |
questions.existing_answer |
object (free-form) | |
questions.question_options |
array of anys | |
questions.min_value |
string (decimal) | Minimum value allowed for NUMBER, YEAR, and RATING type questions |
questions.max_value |
string (decimal) | Maximum value allowed for NUMBER, YEAR, and RATING type questions |
questions.allowed_file_types |
any | List of allowed file extensions (e.g., ['.pdf', '.doc', '.docx']). If empty, all file types are allowed. |
questions.allowed_mime_types |
any | List of allowed MIME types (e.g., ['application/pdf', 'application/msword']). If empty, MIME type validation is not enforced. When both extensions and MIME types are specified, files must match both criteria for security. |
questions.max_file_size_mb |
integer | Maximum file size in megabytes. If not set, no size limit is enforced. |
questions.max_files_count |
integer | Maximum number of files allowed for MULTIPLE_FILES type questions. If not set, no count limit is enforced. |
questions.dependencies_info |
object (free-form) |
400 -
404 -
Get checklist template for creating new objects
Get checklist template for creating new objects.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required | Description |
|---|---|---|---|
parent_uuid |
string (uuid) | ✓ | UUID of the parent object (e.g., customer UUID for new projects) |
200 -
| Field | Type | Description |
|---|---|---|
checklist |
object (free-form) | |
questions |
array of objects | |
questions.uuid |
string (uuid) | |
questions.required |
boolean | |
questions.description |
string | |
questions.user_guidance |
string | Additional guidance text visible to users when answering and reviewing |
questions.question_options |
array of objects | |
questions.question_options.uuid |
string (uuid) | |
questions.question_options.label |
string | |
questions.question_options.order |
integer | |
questions.question_type |
any | Type of question and expected answer format |
questions.order |
integer | |
questions.min_value |
string (decimal) | Minimum value allowed for NUMBER, YEAR, and RATING type questions |
questions.max_value |
string (decimal) | Maximum value allowed for NUMBER, YEAR, and RATING type questions |
questions.allowed_file_types |
any | List of allowed file extensions (e.g., ['.pdf', '.doc', '.docx']). If empty, all file types are allowed. |
questions.allowed_mime_types |
any | List of allowed MIME types (e.g., ['application/pdf', 'application/msword']). If empty, MIME type validation is not enforced. When both extensions and MIME types are specified, files must match both criteria for security. |
questions.max_file_size_mb |
integer | Maximum file size in megabytes. If not set, no size limit is enforced. |
questions.max_files_count |
integer | Maximum number of files allowed for MULTIPLE_FILES type questions. If not set, no count limit is enforced. |
questions.operator |
any | |
questions.review_answer_value |
any | Answer value that trigger review. |
questions.always_requires_review |
boolean | This question always requires review regardless of answer |
questions.guidance_answer_value |
any | Answer value that triggers display of user guidance. |
questions.guidance_operator |
any | Operator to use when comparing answer with guidance_answer_value |
questions.always_show_guidance |
boolean | Show user guidance always, regardless of answer. If False, guidance is conditional on answer matching guidance_answer_value with guidance_operator |
questions.dependency_logic_operator |
any | Defines how multiple dependencies are evaluated. AND: All dependencies must be satisfied. OR: At least one dependency must be satisfied. |
initial_visible_questions |
array of objects | |
initial_visible_questions.uuid |
string (uuid) | |
initial_visible_questions.required |
boolean | |
initial_visible_questions.description |
string | |
initial_visible_questions.user_guidance |
string | Additional guidance text visible to users when answering and reviewing |
initial_visible_questions.question_options |
array of objects | |
initial_visible_questions.question_options.uuid |
string (uuid) | |
initial_visible_questions.question_options.label |
string | |
initial_visible_questions.question_options.order |
integer | |
initial_visible_questions.question_type |
any | Type of question and expected answer format |
initial_visible_questions.order |
integer | |
initial_visible_questions.min_value |
string (decimal) | Minimum value allowed for NUMBER, YEAR, and RATING type questions |
initial_visible_questions.max_value |
string (decimal) | Maximum value allowed for NUMBER, YEAR, and RATING type questions |
initial_visible_questions.allowed_file_types |
any | List of allowed file extensions (e.g., ['.pdf', '.doc', '.docx']). If empty, all file types are allowed. |
initial_visible_questions.allowed_mime_types |
any | List of allowed MIME types (e.g., ['application/pdf', 'application/msword']). If empty, MIME type validation is not enforced. When both extensions and MIME types are specified, files must match both criteria for security. |
initial_visible_questions.max_file_size_mb |
integer | Maximum file size in megabytes. If not set, no size limit is enforced. |
initial_visible_questions.max_files_count |
integer | Maximum number of files allowed for MULTIPLE_FILES type questions. If not set, no count limit is enforced. |
initial_visible_questions.operator |
any | |
initial_visible_questions.review_answer_value |
any | Answer value that trigger review. |
initial_visible_questions.always_requires_review |
boolean | This question always requires review regardless of answer |
initial_visible_questions.guidance_answer_value |
any | Answer value that triggers display of user guidance. |
initial_visible_questions.guidance_operator |
any | Operator to use when comparing answer with guidance_answer_value |
initial_visible_questions.always_show_guidance |
boolean | Show user guidance always, regardless of answer. If False, guidance is conditional on answer matching guidance_answer_value with guidance_operator |
initial_visible_questions.dependency_logic_operator |
any | Defines how multiple dependencies are evaluated. AND: All dependencies must be satisfied. OR: At least one dependency must be satisfied. |
400 -
404 -
Get checklist completion status
Get checklist completion status.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
is_completed |
boolean | Whether all required questions have been answered |
completion_percentage |
number (double) | |
unanswered_required_questions |
array of anys | |
checklist_name |
string | |
checklist_description |
string | |
created |
string (date-time) | |
modified |
string (date-time) |
400 -
404 -
Get project resource usage statistics
Provides statistics about the resource usage (e.g., CPU, RAM, storage) for all resources within a project. Can be filtered to show usage for the current month only.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openportal_unmanaged_projects_stats_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
for_current_month |
boolean | If true, returns usage data for the current month only. Otherwise, returns total usage. |
200 -
| Field | Type |
|---|---|
components |
array of objects |
components.type |
string |
components.name |
string |
components.description |
string |
components.measured_unit |
string |
components.billing_type |
string |
components.usage |
integer |
components.limit_usage |
integer |
components.limit |
integer |
components.offering_name |
string |
components.offering_uuid |
string (uuid) |
Move project to another customer
Moves a project and its associated resources to a different customer. You can choose whether to preserve existing project permissions for users. Terminated projects can also be moved.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
MoveProjectRequest - API Source:
openportal_unmanaged_projects_move_project
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
customer |
string (uri) | ✓ |
preserve_permissions |
boolean | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
slug |
string | URL-friendly identifier. Only editable by staff users. |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_slug |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
description |
string | Project description (HTML content will be sanitized) |
customer_display_billing_info_in_projects |
boolean | |
created |
string (date-time) | |
type |
string (uri) | |
type_name |
string | |
type_uuid |
string (uuid) | |
backend_id |
string | |
start_date |
string (date) | Project start date. Cannot be edited after the start date has arrived. |
end_date |
string (date) | Project end date. Setting this field requires DELETE_PROJECT permission. |
end_date_requested_by |
string (uri) | |
oecd_fos_2007_code |
any | |
oecd_fos_2007_label |
string | Human-readable label for the OECD FOS 2007 classification code |
is_industry |
boolean | |
image |
string (uri) | |
resources_count |
integer | Number of active resources in this project |
max_service_accounts |
integer | Maximum number of service accounts allowed |
kind |
any | |
is_removed |
boolean | |
termination_metadata |
any | Metadata about project termination (read-only) |
staff_notes |
string | Internal notes visible only to staff and support users (HTML content will be sanitized) |
grace_period_days |
integer | Number of extra days after project end date before resources are terminated. Overrides customer-level setting. |
user_email_patterns |
any | |
user_affiliations |
any | |
user_identity_sources |
any | List of allowed identity sources (identity providers). |
project_credit |
number (double) | |
marketplace_resource_count |
object (free-form) | |
billing_price_estimate |
any |
Recover a soft-deleted project
Recovers a soft-deleted (terminated) project, making it active again. Provides options to restore previous team members automatically (staff-only) or send them new invitations.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
ProjectRecoveryRequest - API Source:
openportal_unmanaged_projects_recover
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
restore_team_members |
boolean | Whether to automatically restore team members who had access before project deletion (staff only) Constraints: default: False |
|
send_invitations_to_previous_members |
boolean | Whether to send invitations to users who had access before project deletion Constraints: default: False |
|
end_date |
string (date) | End date for the recovered project |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
slug |
string | URL-friendly identifier. Only editable by staff users. |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_slug |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
description |
string | Project description (HTML content will be sanitized) |
customer_display_billing_info_in_projects |
boolean | |
created |
string (date-time) | |
type |
string (uri) | |
type_name |
string | |
type_uuid |
string (uuid) | |
backend_id |
string | |
start_date |
string (date) | Project start date. Cannot be edited after the start date has arrived. |
end_date |
string (date) | Project end date. Setting this field requires DELETE_PROJECT permission. |
end_date_requested_by |
string (uri) | |
oecd_fos_2007_code |
any | |
oecd_fos_2007_label |
string | Human-readable label for the OECD FOS 2007 classification code |
is_industry |
boolean | |
image |
string (uri) | |
resources_count |
integer | Number of active resources in this project |
max_service_accounts |
integer | Maximum number of service accounts allowed |
kind |
any | |
is_removed |
boolean | |
termination_metadata |
any | Metadata about project termination (read-only) |
staff_notes |
string | Internal notes visible only to staff and support users (HTML content will be sanitized) |
grace_period_days |
integer | Number of extra days after project end date before resources are terminated. Overrides customer-level setting. |
user_email_patterns |
any | |
user_affiliations |
any | |
user_identity_sources |
any | List of allowed identity sources (identity providers). |
project_credit |
number (double) | |
marketplace_resource_count |
object (free-form) | |
billing_price_estimate |
any |
Submit checklist answers
Submit checklist answers.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openportal_unmanaged_projects_submit_answers
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
The request body is an array of objects, where each object has the following structure:
| Field | Type | Required |
|---|---|---|
question_uuid |
string (uuid) | ✓ |
answer_data |
any | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
detail |
string | |
completion |
object | |
completion.uuid |
string (uuid) | |
completion.is_completed |
boolean | Whether all required questions have been answered |
completion.completion_percentage |
number (double) | |
completion.unanswered_required_questions |
array of anys | |
completion.checklist_name |
string | |
completion.checklist_description |
string | |
completion.created |
string (date-time) | |
completion.modified |
string (date-time) |
400 -
404 -
Openportal Userinfo
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/openportal-userinfo/ |
List Openportal Userinfo |
| GET | /api/openportal-userinfo/{user}/ |
Retrieve |
| POST | /api/openportal-userinfo/ |
Create |
| PUT | /api/openportal-userinfo/{user}/ |
Update |
| PATCH | /api/openportal-userinfo/{user}/ |
Partial Update |
| DELETE | /api/openportal-userinfo/{user}/ |
Delete |
| Other Actions | ||
| GET | /api/openportal-userinfo/me/ |
List Openportal Userinfo Me |
| PUT | /api/openportal-userinfo/{user}/set_shortname/ |
Set shortname |
Core CRUD
List Openportal Userinfo
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
openportal_userinfo_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
user |
string (uri) | |
user_uuid |
string (uuid) |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
shortname |
string | A short, unique name for you. It will be used to form your local username on any systems. Should only contain lower-case letters and digits and must start with a letter. |
user |
string (uri) |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openportal_userinfo_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
user |
integer (uri) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
shortname |
string | A short, unique name for you. It will be used to form your local username on any systems. Should only contain lower-case letters and digits and must start with a letter. |
user |
string (uri) |
Create
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
- Model Source:
UserInfoRequest - API Source:
openportal_userinfo_create
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Field | Type | Required | Description |
|---|---|---|---|
shortname |
string | A short, unique name for you. It will be used to form your local username on any systems. Should only contain lower-case letters and digits and must start with a letter. | |
user |
string (uri) | ✓ |
201 -
| Field | Type | Description |
|---|---|---|
shortname |
string | A short, unique name for you. It will be used to form your local username on any systems. Should only contain lower-case letters and digits and must start with a letter. |
user |
string (uri) |
Update
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
UserInfoRequest - API Source:
openportal_userinfo_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
user |
integer (uri) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
shortname |
string | A short, unique name for you. It will be used to form your local username on any systems. Should only contain lower-case letters and digits and must start with a letter. | |
user |
string (uri) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
shortname |
string | A short, unique name for you. It will be used to form your local username on any systems. Should only contain lower-case letters and digits and must start with a letter. |
user |
string (uri) |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedUserInfoRequest - API Source:
openportal_userinfo_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
user |
integer (uri) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
shortname |
string | A short, unique name for you. It will be used to form your local username on any systems. Should only contain lower-case letters and digits and must start with a letter. | |
user |
string (uri) |
200 -
| Field | Type | Description |
|---|---|---|
shortname |
string | A short, unique name for you. It will be used to form your local username on any systems. Should only contain lower-case letters and digits and must start with a letter. |
user |
string (uri) |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openportal_userinfo_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
user |
integer (uri) | ✓ |
204 - No response body
Other Actions
List Openportal Userinfo Me
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
- API Source:
openportal_userinfo_me_retrieve
1 2 3 4 5 6 7 8 9 10 | |
200 -
| Field | Type | Description |
|---|---|---|
shortname |
string | A short, unique name for you. It will be used to form your local username on any systems. Should only contain lower-case letters and digits and must start with a letter. |
user |
string (uri) |
Set shortname
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
UserInfoRequest - API Source:
openportal_userinfo_set_shortname_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
user |
integer (uri) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
shortname |
string | A short, unique name for you. It will be used to form your local username on any systems. Should only contain lower-case letters and digits and must start with a letter. | |
user |
string (uri) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
shortname |
string | A short, unique name for you. It will be used to form your local username on any systems. Should only contain lower-case letters and digits and must start with a letter. |
user |
string (uri) |
Openstack
Openstack Backups
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/openstack-backups/ |
List backups |
| GET | /api/openstack-backups/{uuid}/ |
Get backup details |
| POST | /api/openstack-backups/{uuid}/pull/ |
Synchronize resource state |
| POST | /api/openstack-backups/{uuid}/unlink/ |
Unlink resource |
| PUT | /api/openstack-backups/{uuid}/ |
Update backup |
| PATCH | /api/openstack-backups/{uuid}/ |
Partially update backup |
| DELETE | /api/openstack-backups/{uuid}/ |
Delete backup |
| Other Actions | ||
| POST | /api/openstack-backups/{uuid}/restore/ |
Restore instance from backup |
| POST | /api/openstack-backups/{uuid}/set_erred/ |
Mark resource as ERRED |
| POST | /api/openstack-backups/{uuid}/set_ok/ |
Mark resource as OK |
Core CRUD
List backups
Get a list of instance backups.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- Model Source:
CoreStates - Model Source:
OpenStackBackupFieldEnum - API Source:
openstack_backups_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
backend_id |
string | Backend ID |
can_manage |
boolean | Can manage |
customer |
string (uuid) | Customer UUID |
customer_abbreviation |
string | Customer abbreviation |
customer_name |
string | Customer name |
customer_native_name |
string | Customer native name |
customer_uuid |
string (uuid) | Customer UUID |
description |
string | Description |
external_ip |
string | External IP |
field |
array | |
instance |
string (uri) | Instance URL |
instance_uuid |
string (uuid) | Instance UUID |
name |
string | Name |
name_exact |
string | Name (exact) |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
project |
string (uuid) | Project UUID |
project_name |
string | Project name |
project_uuid |
string (uuid) | Project UUID |
service_settings_name |
string | Service settings name |
service_settings_uuid |
string (uuid) | Service settings UUID |
state |
array | State |
tenant |
string (uri) | Tenant URL |
tenant_uuid |
string (uuid) | Tenant UUID |
uuid |
string (uuid) | UUID |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
kept_until |
string (date-time) | Guaranteed time of backup retention. If null - keep forever. |
metadata |
any | |
instance |
string (uri) | Instance that this backup is created from |
instance_name |
string | |
instance_marketplace_uuid |
string (uuid) | |
restorations |
array of objects | |
restorations.uuid |
string (uuid) | |
restorations.instance |
string (uri) | Instance that is being restored from the backup |
restorations.created |
string (date-time) | |
restorations.flavor |
string (uri) | Flavor to be used for the restored instance. If not specified, original instance flavor will be used |
restorations.name |
string | New instance name. Leave blank to use source instance name. |
restorations.floating_ips |
array of objects | |
restorations.floating_ips.url |
string (uri) | |
restorations.floating_ips.uuid |
string (uuid) | |
restorations.floating_ips.address |
any | The public IPv4 address of the floating IP |
restorations.floating_ips.port_fixed_ips |
array of objects | |
restorations.floating_ips.port_fixed_ips.ip_address |
any | IP address to assign to the port |
restorations.floating_ips.port_fixed_ips.subnet_id |
string | ID of the subnet in which to assign the IP address |
restorations.floating_ips.port_mac_address |
string | MAC address of the port |
restorations.floating_ips.subnet |
string (uri) | |
restorations.floating_ips.subnet_uuid |
string (uuid) | |
restorations.floating_ips.subnet_name |
string | |
restorations.floating_ips.subnet_description |
string | |
restorations.floating_ips.subnet_cidr |
string | IPv4 network address in CIDR format (e.g. 192.168.0.0/24) |
restorations.security_groups |
array of objects | |
restorations.security_groups.url |
string (uri) | |
restorations.security_groups.name |
string | |
restorations.security_groups.rules |
array of objects | |
restorations.security_groups.rules.ethertype |
any | IP protocol version - either 'IPv4' or 'IPv6' |
restorations.security_groups.rules.direction |
any | Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing) |
restorations.security_groups.rules.protocol |
any | The network protocol (TCP, UDP, ICMP, or empty for any protocol) |
restorations.security_groups.rules.from_port |
integer | Starting port number in the range (1-65535) |
restorations.security_groups.rules.to_port |
integer | Ending port number in the range (1-65535) |
restorations.security_groups.rules.cidr |
string | CIDR notation for the source/destination network address range |
restorations.security_groups.rules.description |
string | |
restorations.security_groups.rules.remote_group_name |
string | |
restorations.security_groups.rules.remote_group_uuid |
string (uuid) | |
restorations.security_groups.rules.id |
integer | |
restorations.security_groups.description |
string | |
restorations.security_groups.state |
string | |
restorations.ports |
array of objects | |
restorations.ports.url |
string (uri) | |
restorations.ports.fixed_ips |
array of objects | |
restorations.ports.fixed_ips.ip_address |
any | IP address to assign to the port |
restorations.ports.fixed_ips.subnet_id |
string | ID of the subnet in which to assign the IP address |
restorations.ports.mac_address |
string | MAC address of the port |
restorations.ports.subnet |
string (uri) | Subnet to which this port belongs |
restorations.ports.subnet_uuid |
string (uuid) | |
restorations.ports.subnet_name |
string | |
restorations.ports.subnet_description |
string | |
restorations.ports.subnet_cidr |
string | IPv4 network address in CIDR format (e.g. 192.168.0.0/24) |
restorations.ports.allowed_address_pairs |
array of objects | |
restorations.ports.allowed_address_pairs.mac_address |
string | |
restorations.ports.device_id |
string | ID of device (instance, router etc) to which this port is connected |
restorations.ports.device_owner |
string | Entity that uses this port (e.g. network:router_interface) |
restorations.ports.security_groups |
array of objects | |
restorations.ports.security_groups.url |
string (uri) | |
restorations.ports.security_groups.uuid |
string (uuid) | |
restorations.ports.security_groups.name |
string | |
restorations.ports.security_groups.description |
string | |
restorations.ports.security_groups.service_name |
string | |
restorations.ports.security_groups.service_settings |
string (uri) | |
restorations.ports.security_groups.service_settings_uuid |
string (uuid) | |
restorations.ports.security_groups.service_settings_state |
string | |
restorations.ports.security_groups.service_settings_error_message |
string | |
restorations.ports.security_groups.project |
string (uri) | |
restorations.ports.security_groups.project_name |
string | |
restorations.ports.security_groups.project_uuid |
string (uuid) | |
restorations.ports.security_groups.customer |
string (uri) | |
restorations.ports.security_groups.customer_uuid |
string (uuid) | |
restorations.ports.security_groups.customer_name |
string | |
restorations.ports.security_groups.customer_native_name |
string | |
restorations.ports.security_groups.customer_abbreviation |
string | |
restorations.ports.security_groups.error_message |
string | |
restorations.ports.security_groups.error_traceback |
string | |
restorations.ports.security_groups.resource_type |
string | |
restorations.ports.security_groups.state |
any | |
restorations.ports.security_groups.created |
string (date-time) | |
restorations.ports.security_groups.modified |
string (date-time) | |
restorations.ports.security_groups.backend_id |
string | |
restorations.ports.security_groups.access_url |
string | |
restorations.ports.security_groups.tenant |
string (uri) | |
restorations.ports.security_groups.tenant_name |
string | |
restorations.ports.security_groups.tenant_uuid |
string (uuid) | |
restorations.ports.security_groups.rules |
array of objects | |
restorations.ports.security_groups.rules.ethertype |
any | IP protocol version - either 'IPv4' or 'IPv6' |
restorations.ports.security_groups.rules.direction |
any | Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing) |
restorations.ports.security_groups.rules.protocol |
any | The network protocol (TCP, UDP, ICMP, or empty for any protocol) |
restorations.ports.security_groups.rules.from_port |
integer | Starting port number in the range (1-65535) |
restorations.ports.security_groups.rules.to_port |
integer | Ending port number in the range (1-65535) |
restorations.ports.security_groups.rules.cidr |
string | CIDR notation for the source/destination network address range |
restorations.ports.security_groups.rules.description |
string | |
restorations.ports.security_groups.rules.remote_group_name |
string | |
restorations.ports.security_groups.rules.remote_group_uuid |
string (uuid) | |
restorations.ports.security_groups.rules.id |
integer | |
restorations.ports.security_groups.rules.remote_group |
string (uri) | Remote security group that this rule references, if any |
restorations.ports.security_groups.marketplace_offering_uuid |
string | |
restorations.ports.security_groups.marketplace_offering_name |
string | |
restorations.ports.security_groups.marketplace_offering_plugin_options |
object (free-form) | |
restorations.ports.security_groups.marketplace_category_uuid |
string | |
restorations.ports.security_groups.marketplace_category_name |
string | |
restorations.ports.security_groups.marketplace_resource_uuid |
string | |
restorations.ports.security_groups.marketplace_plan_uuid |
string | |
restorations.ports.security_groups.marketplace_resource_state |
string | |
restorations.ports.security_groups.is_usage_based |
boolean | |
restorations.ports.security_groups.is_limit_based |
boolean | |
instance_security_groups |
array of objects | |
instance_security_groups.url |
string (uri) | |
instance_security_groups.name |
string | |
instance_security_groups.rules |
array of objects | |
instance_security_groups.rules.ethertype |
any | IP protocol version - either 'IPv4' or 'IPv6' |
instance_security_groups.rules.direction |
any | Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing) |
instance_security_groups.rules.protocol |
any | The network protocol (TCP, UDP, ICMP, or empty for any protocol) |
instance_security_groups.rules.from_port |
integer | Starting port number in the range (1-65535) |
instance_security_groups.rules.to_port |
integer | Ending port number in the range (1-65535) |
instance_security_groups.rules.cidr |
string | CIDR notation for the source/destination network address range |
instance_security_groups.rules.description |
string | |
instance_security_groups.rules.remote_group_name |
string | |
instance_security_groups.rules.remote_group_uuid |
string (uuid) | |
instance_security_groups.rules.id |
integer | |
instance_security_groups.description |
string | |
instance_security_groups.state |
string | |
instance_ports |
array of objects | |
instance_ports.url |
string (uri) | |
instance_ports.fixed_ips |
array of objects | |
instance_ports.fixed_ips.ip_address |
any | IP address to assign to the port |
instance_ports.fixed_ips.subnet_id |
string | ID of the subnet in which to assign the IP address |
instance_ports.mac_address |
string | MAC address of the port |
instance_ports.subnet |
string (uri) | Subnet to which this port belongs |
instance_ports.subnet_uuid |
string (uuid) | |
instance_ports.subnet_name |
string | |
instance_ports.subnet_description |
string | |
instance_ports.subnet_cidr |
string | IPv4 network address in CIDR format (e.g. 192.168.0.0/24) |
instance_ports.allowed_address_pairs |
array of objects | |
instance_ports.allowed_address_pairs.mac_address |
string | |
instance_ports.device_id |
string | ID of device (instance, router etc) to which this port is connected |
instance_ports.device_owner |
string | Entity that uses this port (e.g. network:router_interface) |
instance_ports.security_groups |
array of objects | |
instance_ports.security_groups.url |
string (uri) | |
instance_ports.security_groups.uuid |
string (uuid) | |
instance_ports.security_groups.name |
string | |
instance_ports.security_groups.description |
string | |
instance_ports.security_groups.service_name |
string | |
instance_ports.security_groups.service_settings |
string (uri) | |
instance_ports.security_groups.service_settings_uuid |
string (uuid) | |
instance_ports.security_groups.service_settings_state |
string | |
instance_ports.security_groups.service_settings_error_message |
string | |
instance_ports.security_groups.project |
string (uri) | |
instance_ports.security_groups.project_name |
string | |
instance_ports.security_groups.project_uuid |
string (uuid) | |
instance_ports.security_groups.customer |
string (uri) | |
instance_ports.security_groups.customer_uuid |
string (uuid) | |
instance_ports.security_groups.customer_name |
string | |
instance_ports.security_groups.customer_native_name |
string | |
instance_ports.security_groups.customer_abbreviation |
string | |
instance_ports.security_groups.error_message |
string | |
instance_ports.security_groups.error_traceback |
string | |
instance_ports.security_groups.resource_type |
string | |
instance_ports.security_groups.state |
any | |
instance_ports.security_groups.created |
string (date-time) | |
instance_ports.security_groups.modified |
string (date-time) | |
instance_ports.security_groups.backend_id |
string | |
instance_ports.security_groups.access_url |
string | |
instance_ports.security_groups.tenant |
string (uri) | |
instance_ports.security_groups.tenant_name |
string | |
instance_ports.security_groups.tenant_uuid |
string (uuid) | |
instance_ports.security_groups.rules |
array of objects | |
instance_ports.security_groups.rules.ethertype |
any | IP protocol version - either 'IPv4' or 'IPv6' |
instance_ports.security_groups.rules.direction |
any | Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing) |
instance_ports.security_groups.rules.protocol |
any | The network protocol (TCP, UDP, ICMP, or empty for any protocol) |
instance_ports.security_groups.rules.from_port |
integer | Starting port number in the range (1-65535) |
instance_ports.security_groups.rules.to_port |
integer | Ending port number in the range (1-65535) |
instance_ports.security_groups.rules.cidr |
string | CIDR notation for the source/destination network address range |
instance_ports.security_groups.rules.description |
string | |
instance_ports.security_groups.rules.remote_group_name |
string | |
instance_ports.security_groups.rules.remote_group_uuid |
string (uuid) | |
instance_ports.security_groups.rules.id |
integer | |
instance_ports.security_groups.rules.remote_group |
string (uri) | Remote security group that this rule references, if any |
instance_ports.security_groups.marketplace_offering_uuid |
string | |
instance_ports.security_groups.marketplace_offering_name |
string | |
instance_ports.security_groups.marketplace_offering_plugin_options |
object (free-form) | |
instance_ports.security_groups.marketplace_category_uuid |
string | |
instance_ports.security_groups.marketplace_category_name |
string | |
instance_ports.security_groups.marketplace_resource_uuid |
string | |
instance_ports.security_groups.marketplace_plan_uuid |
string | |
instance_ports.security_groups.marketplace_resource_state |
string | |
instance_ports.security_groups.is_usage_based |
boolean | |
instance_ports.security_groups.is_limit_based |
boolean | |
instance_floating_ips |
array of objects | |
instance_floating_ips.url |
string (uri) | |
instance_floating_ips.uuid |
string (uuid) | |
instance_floating_ips.address |
any | The public IPv4 address of the floating IP |
instance_floating_ips.port_fixed_ips |
array of objects | |
instance_floating_ips.port_fixed_ips.ip_address |
any | IP address to assign to the port |
instance_floating_ips.port_fixed_ips.subnet_id |
string | ID of the subnet in which to assign the IP address |
instance_floating_ips.port_mac_address |
string | MAC address of the port |
instance_floating_ips.subnet |
string (uri) | |
instance_floating_ips.subnet_uuid |
string (uuid) | |
instance_floating_ips.subnet_name |
string | |
instance_floating_ips.subnet_description |
string | |
instance_floating_ips.subnet_cidr |
string | IPv4 network address in CIDR format (e.g. 192.168.0.0/24) |
tenant_uuid |
string (uuid) | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Get backup details
Retrieve details of a specific instance backup.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
OpenStackBackupFieldEnum - API Source:
openstack_backups_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
kept_until |
string (date-time) | Guaranteed time of backup retention. If null - keep forever. |
metadata |
any | |
instance |
string (uri) | Instance that this backup is created from |
instance_name |
string | |
instance_marketplace_uuid |
string (uuid) | |
restorations |
array of objects | |
restorations.uuid |
string (uuid) | |
restorations.instance |
string (uri) | Instance that is being restored from the backup |
restorations.created |
string (date-time) | |
restorations.flavor |
string (uri) | Flavor to be used for the restored instance. If not specified, original instance flavor will be used |
restorations.name |
string | New instance name. Leave blank to use source instance name. |
restorations.floating_ips |
array of objects | |
restorations.floating_ips.url |
string (uri) | |
restorations.floating_ips.uuid |
string (uuid) | |
restorations.floating_ips.address |
any | The public IPv4 address of the floating IP |
restorations.floating_ips.port_fixed_ips |
array of objects | |
restorations.floating_ips.port_fixed_ips.ip_address |
any | IP address to assign to the port |
restorations.floating_ips.port_fixed_ips.subnet_id |
string | ID of the subnet in which to assign the IP address |
restorations.floating_ips.port_mac_address |
string | MAC address of the port |
restorations.floating_ips.subnet |
string (uri) | |
restorations.floating_ips.subnet_uuid |
string (uuid) | |
restorations.floating_ips.subnet_name |
string | |
restorations.floating_ips.subnet_description |
string | |
restorations.floating_ips.subnet_cidr |
string | IPv4 network address in CIDR format (e.g. 192.168.0.0/24) |
restorations.security_groups |
array of objects | |
restorations.security_groups.url |
string (uri) | |
restorations.security_groups.name |
string | |
restorations.security_groups.rules |
array of objects | |
restorations.security_groups.rules.ethertype |
any | IP protocol version - either 'IPv4' or 'IPv6' |
restorations.security_groups.rules.direction |
any | Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing) |
restorations.security_groups.rules.protocol |
any | The network protocol (TCP, UDP, ICMP, or empty for any protocol) |
restorations.security_groups.rules.from_port |
integer | Starting port number in the range (1-65535) |
restorations.security_groups.rules.to_port |
integer | Ending port number in the range (1-65535) |
restorations.security_groups.rules.cidr |
string | CIDR notation for the source/destination network address range |
restorations.security_groups.rules.description |
string | |
restorations.security_groups.rules.remote_group_name |
string | |
restorations.security_groups.rules.remote_group_uuid |
string (uuid) | |
restorations.security_groups.rules.id |
integer | |
restorations.security_groups.description |
string | |
restorations.security_groups.state |
string | |
restorations.ports |
array of objects | |
restorations.ports.url |
string (uri) | |
restorations.ports.fixed_ips |
array of objects | |
restorations.ports.fixed_ips.ip_address |
any | IP address to assign to the port |
restorations.ports.fixed_ips.subnet_id |
string | ID of the subnet in which to assign the IP address |
restorations.ports.mac_address |
string | MAC address of the port |
restorations.ports.subnet |
string (uri) | Subnet to which this port belongs |
restorations.ports.subnet_uuid |
string (uuid) | |
restorations.ports.subnet_name |
string | |
restorations.ports.subnet_description |
string | |
restorations.ports.subnet_cidr |
string | IPv4 network address in CIDR format (e.g. 192.168.0.0/24) |
restorations.ports.allowed_address_pairs |
array of objects | |
restorations.ports.allowed_address_pairs.mac_address |
string | |
restorations.ports.device_id |
string | ID of device (instance, router etc) to which this port is connected |
restorations.ports.device_owner |
string | Entity that uses this port (e.g. network:router_interface) |
restorations.ports.security_groups |
array of objects | |
restorations.ports.security_groups.url |
string (uri) | |
restorations.ports.security_groups.uuid |
string (uuid) | |
restorations.ports.security_groups.name |
string | |
restorations.ports.security_groups.description |
string | |
restorations.ports.security_groups.service_name |
string | |
restorations.ports.security_groups.service_settings |
string (uri) | |
restorations.ports.security_groups.service_settings_uuid |
string (uuid) | |
restorations.ports.security_groups.service_settings_state |
string | |
restorations.ports.security_groups.service_settings_error_message |
string | |
restorations.ports.security_groups.project |
string (uri) | |
restorations.ports.security_groups.project_name |
string | |
restorations.ports.security_groups.project_uuid |
string (uuid) | |
restorations.ports.security_groups.customer |
string (uri) | |
restorations.ports.security_groups.customer_uuid |
string (uuid) | |
restorations.ports.security_groups.customer_name |
string | |
restorations.ports.security_groups.customer_native_name |
string | |
restorations.ports.security_groups.customer_abbreviation |
string | |
restorations.ports.security_groups.error_message |
string | |
restorations.ports.security_groups.error_traceback |
string | |
restorations.ports.security_groups.resource_type |
string | |
restorations.ports.security_groups.state |
any | |
restorations.ports.security_groups.created |
string (date-time) | |
restorations.ports.security_groups.modified |
string (date-time) | |
restorations.ports.security_groups.backend_id |
string | |
restorations.ports.security_groups.access_url |
string | |
restorations.ports.security_groups.tenant |
string (uri) | |
restorations.ports.security_groups.tenant_name |
string | |
restorations.ports.security_groups.tenant_uuid |
string (uuid) | |
restorations.ports.security_groups.rules |
array of objects | |
restorations.ports.security_groups.rules.ethertype |
any | IP protocol version - either 'IPv4' or 'IPv6' |
restorations.ports.security_groups.rules.direction |
any | Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing) |
restorations.ports.security_groups.rules.protocol |
any | The network protocol (TCP, UDP, ICMP, or empty for any protocol) |
restorations.ports.security_groups.rules.from_port |
integer | Starting port number in the range (1-65535) |
restorations.ports.security_groups.rules.to_port |
integer | Ending port number in the range (1-65535) |
restorations.ports.security_groups.rules.cidr |
string | CIDR notation for the source/destination network address range |
restorations.ports.security_groups.rules.description |
string | |
restorations.ports.security_groups.rules.remote_group_name |
string | |
restorations.ports.security_groups.rules.remote_group_uuid |
string (uuid) | |
restorations.ports.security_groups.rules.id |
integer | |
restorations.ports.security_groups.rules.remote_group |
string (uri) | Remote security group that this rule references, if any |
restorations.ports.security_groups.marketplace_offering_uuid |
string | |
restorations.ports.security_groups.marketplace_offering_name |
string | |
restorations.ports.security_groups.marketplace_offering_plugin_options |
object (free-form) | |
restorations.ports.security_groups.marketplace_category_uuid |
string | |
restorations.ports.security_groups.marketplace_category_name |
string | |
restorations.ports.security_groups.marketplace_resource_uuid |
string | |
restorations.ports.security_groups.marketplace_plan_uuid |
string | |
restorations.ports.security_groups.marketplace_resource_state |
string | |
restorations.ports.security_groups.is_usage_based |
boolean | |
restorations.ports.security_groups.is_limit_based |
boolean | |
instance_security_groups |
array of objects | |
instance_security_groups.url |
string (uri) | |
instance_security_groups.name |
string | |
instance_security_groups.rules |
array of objects | |
instance_security_groups.rules.ethertype |
any | IP protocol version - either 'IPv4' or 'IPv6' |
instance_security_groups.rules.direction |
any | Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing) |
instance_security_groups.rules.protocol |
any | The network protocol (TCP, UDP, ICMP, or empty for any protocol) |
instance_security_groups.rules.from_port |
integer | Starting port number in the range (1-65535) |
instance_security_groups.rules.to_port |
integer | Ending port number in the range (1-65535) |
instance_security_groups.rules.cidr |
string | CIDR notation for the source/destination network address range |
instance_security_groups.rules.description |
string | |
instance_security_groups.rules.remote_group_name |
string | |
instance_security_groups.rules.remote_group_uuid |
string (uuid) | |
instance_security_groups.rules.id |
integer | |
instance_security_groups.description |
string | |
instance_security_groups.state |
string | |
instance_ports |
array of objects | |
instance_ports.url |
string (uri) | |
instance_ports.fixed_ips |
array of objects | |
instance_ports.fixed_ips.ip_address |
any | IP address to assign to the port |
instance_ports.fixed_ips.subnet_id |
string | ID of the subnet in which to assign the IP address |
instance_ports.mac_address |
string | MAC address of the port |
instance_ports.subnet |
string (uri) | Subnet to which this port belongs |
instance_ports.subnet_uuid |
string (uuid) | |
instance_ports.subnet_name |
string | |
instance_ports.subnet_description |
string | |
instance_ports.subnet_cidr |
string | IPv4 network address in CIDR format (e.g. 192.168.0.0/24) |
instance_ports.allowed_address_pairs |
array of objects | |
instance_ports.allowed_address_pairs.mac_address |
string | |
instance_ports.device_id |
string | ID of device (instance, router etc) to which this port is connected |
instance_ports.device_owner |
string | Entity that uses this port (e.g. network:router_interface) |
instance_ports.security_groups |
array of objects | |
instance_ports.security_groups.url |
string (uri) | |
instance_ports.security_groups.uuid |
string (uuid) | |
instance_ports.security_groups.name |
string | |
instance_ports.security_groups.description |
string | |
instance_ports.security_groups.service_name |
string | |
instance_ports.security_groups.service_settings |
string (uri) | |
instance_ports.security_groups.service_settings_uuid |
string (uuid) | |
instance_ports.security_groups.service_settings_state |
string | |
instance_ports.security_groups.service_settings_error_message |
string | |
instance_ports.security_groups.project |
string (uri) | |
instance_ports.security_groups.project_name |
string | |
instance_ports.security_groups.project_uuid |
string (uuid) | |
instance_ports.security_groups.customer |
string (uri) | |
instance_ports.security_groups.customer_uuid |
string (uuid) | |
instance_ports.security_groups.customer_name |
string | |
instance_ports.security_groups.customer_native_name |
string | |
instance_ports.security_groups.customer_abbreviation |
string | |
instance_ports.security_groups.error_message |
string | |
instance_ports.security_groups.error_traceback |
string | |
instance_ports.security_groups.resource_type |
string | |
instance_ports.security_groups.state |
any | |
instance_ports.security_groups.created |
string (date-time) | |
instance_ports.security_groups.modified |
string (date-time) | |
instance_ports.security_groups.backend_id |
string | |
instance_ports.security_groups.access_url |
string | |
instance_ports.security_groups.tenant |
string (uri) | |
instance_ports.security_groups.tenant_name |
string | |
instance_ports.security_groups.tenant_uuid |
string (uuid) | |
instance_ports.security_groups.rules |
array of objects | |
instance_ports.security_groups.rules.ethertype |
any | IP protocol version - either 'IPv4' or 'IPv6' |
instance_ports.security_groups.rules.direction |
any | Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing) |
instance_ports.security_groups.rules.protocol |
any | The network protocol (TCP, UDP, ICMP, or empty for any protocol) |
instance_ports.security_groups.rules.from_port |
integer | Starting port number in the range (1-65535) |
instance_ports.security_groups.rules.to_port |
integer | Ending port number in the range (1-65535) |
instance_ports.security_groups.rules.cidr |
string | CIDR notation for the source/destination network address range |
instance_ports.security_groups.rules.description |
string | |
instance_ports.security_groups.rules.remote_group_name |
string | |
instance_ports.security_groups.rules.remote_group_uuid |
string (uuid) | |
instance_ports.security_groups.rules.id |
integer | |
instance_ports.security_groups.rules.remote_group |
string (uri) | Remote security group that this rule references, if any |
instance_ports.security_groups.marketplace_offering_uuid |
string | |
instance_ports.security_groups.marketplace_offering_name |
string | |
instance_ports.security_groups.marketplace_offering_plugin_options |
object (free-form) | |
instance_ports.security_groups.marketplace_category_uuid |
string | |
instance_ports.security_groups.marketplace_category_name |
string | |
instance_ports.security_groups.marketplace_resource_uuid |
string | |
instance_ports.security_groups.marketplace_plan_uuid |
string | |
instance_ports.security_groups.marketplace_resource_state |
string | |
instance_ports.security_groups.is_usage_based |
boolean | |
instance_ports.security_groups.is_limit_based |
boolean | |
instance_floating_ips |
array of objects | |
instance_floating_ips.url |
string (uri) | |
instance_floating_ips.uuid |
string (uuid) | |
instance_floating_ips.address |
any | The public IPv4 address of the floating IP |
instance_floating_ips.port_fixed_ips |
array of objects | |
instance_floating_ips.port_fixed_ips.ip_address |
any | IP address to assign to the port |
instance_floating_ips.port_fixed_ips.subnet_id |
string | ID of the subnet in which to assign the IP address |
instance_floating_ips.port_mac_address |
string | MAC address of the port |
instance_floating_ips.subnet |
string (uri) | |
instance_floating_ips.subnet_uuid |
string (uuid) | |
instance_floating_ips.subnet_name |
string | |
instance_floating_ips.subnet_description |
string | |
instance_floating_ips.subnet_cidr |
string | IPv4 network address in CIDR format (e.g. 192.168.0.0/24) |
tenant_uuid |
string (uuid) | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Synchronize resource state
Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_backups_pull
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
202 -
| Field | Type |
|---|---|
detail |
string |
409 -
| Field | Type |
|---|---|
detail |
string |
Unlink resource
Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_backups_unlink
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Update backup
Update an existing instance backup.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
OpenStackBackupRequest - API Source:
openstack_backups_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ✓ | |
description |
string | ||
kept_until |
string (date-time) | Guaranteed time of backup retention. If null - keep forever. |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
kept_until |
string (date-time) | Guaranteed time of backup retention. If null - keep forever. |
metadata |
any | |
instance |
string (uri) | Instance that this backup is created from |
instance_name |
string | |
instance_marketplace_uuid |
string (uuid) | |
restorations |
array of objects | |
restorations.uuid |
string (uuid) | |
restorations.instance |
string (uri) | Instance that is being restored from the backup |
restorations.created |
string (date-time) | |
restorations.flavor |
string (uri) | Flavor to be used for the restored instance. If not specified, original instance flavor will be used |
restorations.name |
string | New instance name. Leave blank to use source instance name. |
restorations.floating_ips |
array of objects | |
restorations.floating_ips.url |
string (uri) | |
restorations.floating_ips.uuid |
string (uuid) | |
restorations.floating_ips.address |
any | The public IPv4 address of the floating IP |
restorations.floating_ips.port_fixed_ips |
array of objects | |
restorations.floating_ips.port_fixed_ips.ip_address |
any | IP address to assign to the port |
restorations.floating_ips.port_fixed_ips.subnet_id |
string | ID of the subnet in which to assign the IP address |
restorations.floating_ips.port_mac_address |
string | MAC address of the port |
restorations.floating_ips.subnet |
string (uri) | |
restorations.floating_ips.subnet_uuid |
string (uuid) | |
restorations.floating_ips.subnet_name |
string | |
restorations.floating_ips.subnet_description |
string | |
restorations.floating_ips.subnet_cidr |
string | IPv4 network address in CIDR format (e.g. 192.168.0.0/24) |
restorations.security_groups |
array of objects | |
restorations.security_groups.url |
string (uri) | |
restorations.security_groups.name |
string | |
restorations.security_groups.rules |
array of objects | |
restorations.security_groups.rules.ethertype |
any | IP protocol version - either 'IPv4' or 'IPv6' |
restorations.security_groups.rules.direction |
any | Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing) |
restorations.security_groups.rules.protocol |
any | The network protocol (TCP, UDP, ICMP, or empty for any protocol) |
restorations.security_groups.rules.from_port |
integer | Starting port number in the range (1-65535) |
restorations.security_groups.rules.to_port |
integer | Ending port number in the range (1-65535) |
restorations.security_groups.rules.cidr |
string | CIDR notation for the source/destination network address range |
restorations.security_groups.rules.description |
string | |
restorations.security_groups.rules.remote_group_name |
string | |
restorations.security_groups.rules.remote_group_uuid |
string (uuid) | |
restorations.security_groups.rules.id |
integer | |
restorations.security_groups.description |
string | |
restorations.security_groups.state |
string | |
restorations.ports |
array of objects | |
restorations.ports.url |
string (uri) | |
restorations.ports.fixed_ips |
array of objects | |
restorations.ports.fixed_ips.ip_address |
any | IP address to assign to the port |
restorations.ports.fixed_ips.subnet_id |
string | ID of the subnet in which to assign the IP address |
restorations.ports.mac_address |
string | MAC address of the port |
restorations.ports.subnet |
string (uri) | Subnet to which this port belongs |
restorations.ports.subnet_uuid |
string (uuid) | |
restorations.ports.subnet_name |
string | |
restorations.ports.subnet_description |
string | |
restorations.ports.subnet_cidr |
string | IPv4 network address in CIDR format (e.g. 192.168.0.0/24) |
restorations.ports.allowed_address_pairs |
array of objects | |
restorations.ports.allowed_address_pairs.mac_address |
string | |
restorations.ports.device_id |
string | ID of device (instance, router etc) to which this port is connected |
restorations.ports.device_owner |
string | Entity that uses this port (e.g. network:router_interface) |
restorations.ports.security_groups |
array of objects | |
restorations.ports.security_groups.url |
string (uri) | |
restorations.ports.security_groups.uuid |
string (uuid) | |
restorations.ports.security_groups.name |
string | |
restorations.ports.security_groups.description |
string | |
restorations.ports.security_groups.service_name |
string | |
restorations.ports.security_groups.service_settings |
string (uri) | |
restorations.ports.security_groups.service_settings_uuid |
string (uuid) | |
restorations.ports.security_groups.service_settings_state |
string | |
restorations.ports.security_groups.service_settings_error_message |
string | |
restorations.ports.security_groups.project |
string (uri) | |
restorations.ports.security_groups.project_name |
string | |
restorations.ports.security_groups.project_uuid |
string (uuid) | |
restorations.ports.security_groups.customer |
string (uri) | |
restorations.ports.security_groups.customer_uuid |
string (uuid) | |
restorations.ports.security_groups.customer_name |
string | |
restorations.ports.security_groups.customer_native_name |
string | |
restorations.ports.security_groups.customer_abbreviation |
string | |
restorations.ports.security_groups.error_message |
string | |
restorations.ports.security_groups.error_traceback |
string | |
restorations.ports.security_groups.resource_type |
string | |
restorations.ports.security_groups.state |
any | |
restorations.ports.security_groups.created |
string (date-time) | |
restorations.ports.security_groups.modified |
string (date-time) | |
restorations.ports.security_groups.backend_id |
string | |
restorations.ports.security_groups.access_url |
string | |
restorations.ports.security_groups.tenant |
string (uri) | |
restorations.ports.security_groups.tenant_name |
string | |
restorations.ports.security_groups.tenant_uuid |
string (uuid) | |
restorations.ports.security_groups.rules |
array of objects | |
restorations.ports.security_groups.rules.ethertype |
any | IP protocol version - either 'IPv4' or 'IPv6' |
restorations.ports.security_groups.rules.direction |
any | Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing) |
restorations.ports.security_groups.rules.protocol |
any | The network protocol (TCP, UDP, ICMP, or empty for any protocol) |
restorations.ports.security_groups.rules.from_port |
integer | Starting port number in the range (1-65535) |
restorations.ports.security_groups.rules.to_port |
integer | Ending port number in the range (1-65535) |
restorations.ports.security_groups.rules.cidr |
string | CIDR notation for the source/destination network address range |
restorations.ports.security_groups.rules.description |
string | |
restorations.ports.security_groups.rules.remote_group_name |
string | |
restorations.ports.security_groups.rules.remote_group_uuid |
string (uuid) | |
restorations.ports.security_groups.rules.id |
integer | |
restorations.ports.security_groups.rules.remote_group |
string (uri) | Remote security group that this rule references, if any |
restorations.ports.security_groups.marketplace_offering_uuid |
string | |
restorations.ports.security_groups.marketplace_offering_name |
string | |
restorations.ports.security_groups.marketplace_offering_plugin_options |
object (free-form) | |
restorations.ports.security_groups.marketplace_category_uuid |
string | |
restorations.ports.security_groups.marketplace_category_name |
string | |
restorations.ports.security_groups.marketplace_resource_uuid |
string | |
restorations.ports.security_groups.marketplace_plan_uuid |
string | |
restorations.ports.security_groups.marketplace_resource_state |
string | |
restorations.ports.security_groups.is_usage_based |
boolean | |
restorations.ports.security_groups.is_limit_based |
boolean | |
instance_security_groups |
array of objects | |
instance_security_groups.url |
string (uri) | |
instance_security_groups.name |
string | |
instance_security_groups.rules |
array of objects | |
instance_security_groups.rules.ethertype |
any | IP protocol version - either 'IPv4' or 'IPv6' |
instance_security_groups.rules.direction |
any | Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing) |
instance_security_groups.rules.protocol |
any | The network protocol (TCP, UDP, ICMP, or empty for any protocol) |
instance_security_groups.rules.from_port |
integer | Starting port number in the range (1-65535) |
instance_security_groups.rules.to_port |
integer | Ending port number in the range (1-65535) |
instance_security_groups.rules.cidr |
string | CIDR notation for the source/destination network address range |
instance_security_groups.rules.description |
string | |
instance_security_groups.rules.remote_group_name |
string | |
instance_security_groups.rules.remote_group_uuid |
string (uuid) | |
instance_security_groups.rules.id |
integer | |
instance_security_groups.description |
string | |
instance_security_groups.state |
string | |
instance_ports |
array of objects | |
instance_ports.url |
string (uri) | |
instance_ports.fixed_ips |
array of objects | |
instance_ports.fixed_ips.ip_address |
any | IP address to assign to the port |
instance_ports.fixed_ips.subnet_id |
string | ID of the subnet in which to assign the IP address |
instance_ports.mac_address |
string | MAC address of the port |
instance_ports.subnet |
string (uri) | Subnet to which this port belongs |
instance_ports.subnet_uuid |
string (uuid) | |
instance_ports.subnet_name |
string | |
instance_ports.subnet_description |
string | |
instance_ports.subnet_cidr |
string | IPv4 network address in CIDR format (e.g. 192.168.0.0/24) |
instance_ports.allowed_address_pairs |
array of objects | |
instance_ports.allowed_address_pairs.mac_address |
string | |
instance_ports.device_id |
string | ID of device (instance, router etc) to which this port is connected |
instance_ports.device_owner |
string | Entity that uses this port (e.g. network:router_interface) |
instance_ports.security_groups |
array of objects | |
instance_ports.security_groups.url |
string (uri) | |
instance_ports.security_groups.uuid |
string (uuid) | |
instance_ports.security_groups.name |
string | |
instance_ports.security_groups.description |
string | |
instance_ports.security_groups.service_name |
string | |
instance_ports.security_groups.service_settings |
string (uri) | |
instance_ports.security_groups.service_settings_uuid |
string (uuid) | |
instance_ports.security_groups.service_settings_state |
string | |
instance_ports.security_groups.service_settings_error_message |
string | |
instance_ports.security_groups.project |
string (uri) | |
instance_ports.security_groups.project_name |
string | |
instance_ports.security_groups.project_uuid |
string (uuid) | |
instance_ports.security_groups.customer |
string (uri) | |
instance_ports.security_groups.customer_uuid |
string (uuid) | |
instance_ports.security_groups.customer_name |
string | |
instance_ports.security_groups.customer_native_name |
string | |
instance_ports.security_groups.customer_abbreviation |
string | |
instance_ports.security_groups.error_message |
string | |
instance_ports.security_groups.error_traceback |
string | |
instance_ports.security_groups.resource_type |
string | |
instance_ports.security_groups.state |
any | |
instance_ports.security_groups.created |
string (date-time) | |
instance_ports.security_groups.modified |
string (date-time) | |
instance_ports.security_groups.backend_id |
string | |
instance_ports.security_groups.access_url |
string | |
instance_ports.security_groups.tenant |
string (uri) | |
instance_ports.security_groups.tenant_name |
string | |
instance_ports.security_groups.tenant_uuid |
string (uuid) | |
instance_ports.security_groups.rules |
array of objects | |
instance_ports.security_groups.rules.ethertype |
any | IP protocol version - either 'IPv4' or 'IPv6' |
instance_ports.security_groups.rules.direction |
any | Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing) |
instance_ports.security_groups.rules.protocol |
any | The network protocol (TCP, UDP, ICMP, or empty for any protocol) |
instance_ports.security_groups.rules.from_port |
integer | Starting port number in the range (1-65535) |
instance_ports.security_groups.rules.to_port |
integer | Ending port number in the range (1-65535) |
instance_ports.security_groups.rules.cidr |
string | CIDR notation for the source/destination network address range |
instance_ports.security_groups.rules.description |
string | |
instance_ports.security_groups.rules.remote_group_name |
string | |
instance_ports.security_groups.rules.remote_group_uuid |
string (uuid) | |
instance_ports.security_groups.rules.id |
integer | |
instance_ports.security_groups.rules.remote_group |
string (uri) | Remote security group that this rule references, if any |
instance_ports.security_groups.marketplace_offering_uuid |
string | |
instance_ports.security_groups.marketplace_offering_name |
string | |
instance_ports.security_groups.marketplace_offering_plugin_options |
object (free-form) | |
instance_ports.security_groups.marketplace_category_uuid |
string | |
instance_ports.security_groups.marketplace_category_name |
string | |
instance_ports.security_groups.marketplace_resource_uuid |
string | |
instance_ports.security_groups.marketplace_plan_uuid |
string | |
instance_ports.security_groups.marketplace_resource_state |
string | |
instance_ports.security_groups.is_usage_based |
boolean | |
instance_ports.security_groups.is_limit_based |
boolean | |
instance_floating_ips |
array of objects | |
instance_floating_ips.url |
string (uri) | |
instance_floating_ips.uuid |
string (uuid) | |
instance_floating_ips.address |
any | The public IPv4 address of the floating IP |
instance_floating_ips.port_fixed_ips |
array of objects | |
instance_floating_ips.port_fixed_ips.ip_address |
any | IP address to assign to the port |
instance_floating_ips.port_fixed_ips.subnet_id |
string | ID of the subnet in which to assign the IP address |
instance_floating_ips.port_mac_address |
string | MAC address of the port |
instance_floating_ips.subnet |
string (uri) | |
instance_floating_ips.subnet_uuid |
string (uuid) | |
instance_floating_ips.subnet_name |
string | |
instance_floating_ips.subnet_description |
string | |
instance_floating_ips.subnet_cidr |
string | IPv4 network address in CIDR format (e.g. 192.168.0.0/24) |
tenant_uuid |
string (uuid) | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Partially update backup
Update specific fields of an instance backup.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedOpenStackBackupRequest - API Source:
openstack_backups_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ||
description |
string | ||
kept_until |
string (date-time) | Guaranteed time of backup retention. If null - keep forever. |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
kept_until |
string (date-time) | Guaranteed time of backup retention. If null - keep forever. |
metadata |
any | |
instance |
string (uri) | Instance that this backup is created from |
instance_name |
string | |
instance_marketplace_uuid |
string (uuid) | |
restorations |
array of objects | |
restorations.uuid |
string (uuid) | |
restorations.instance |
string (uri) | Instance that is being restored from the backup |
restorations.created |
string (date-time) | |
restorations.flavor |
string (uri) | Flavor to be used for the restored instance. If not specified, original instance flavor will be used |
restorations.name |
string | New instance name. Leave blank to use source instance name. |
restorations.floating_ips |
array of objects | |
restorations.floating_ips.url |
string (uri) | |
restorations.floating_ips.uuid |
string (uuid) | |
restorations.floating_ips.address |
any | The public IPv4 address of the floating IP |
restorations.floating_ips.port_fixed_ips |
array of objects | |
restorations.floating_ips.port_fixed_ips.ip_address |
any | IP address to assign to the port |
restorations.floating_ips.port_fixed_ips.subnet_id |
string | ID of the subnet in which to assign the IP address |
restorations.floating_ips.port_mac_address |
string | MAC address of the port |
restorations.floating_ips.subnet |
string (uri) | |
restorations.floating_ips.subnet_uuid |
string (uuid) | |
restorations.floating_ips.subnet_name |
string | |
restorations.floating_ips.subnet_description |
string | |
restorations.floating_ips.subnet_cidr |
string | IPv4 network address in CIDR format (e.g. 192.168.0.0/24) |
restorations.security_groups |
array of objects | |
restorations.security_groups.url |
string (uri) | |
restorations.security_groups.name |
string | |
restorations.security_groups.rules |
array of objects | |
restorations.security_groups.rules.ethertype |
any | IP protocol version - either 'IPv4' or 'IPv6' |
restorations.security_groups.rules.direction |
any | Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing) |
restorations.security_groups.rules.protocol |
any | The network protocol (TCP, UDP, ICMP, or empty for any protocol) |
restorations.security_groups.rules.from_port |
integer | Starting port number in the range (1-65535) |
restorations.security_groups.rules.to_port |
integer | Ending port number in the range (1-65535) |
restorations.security_groups.rules.cidr |
string | CIDR notation for the source/destination network address range |
restorations.security_groups.rules.description |
string | |
restorations.security_groups.rules.remote_group_name |
string | |
restorations.security_groups.rules.remote_group_uuid |
string (uuid) | |
restorations.security_groups.rules.id |
integer | |
restorations.security_groups.description |
string | |
restorations.security_groups.state |
string | |
restorations.ports |
array of objects | |
restorations.ports.url |
string (uri) | |
restorations.ports.fixed_ips |
array of objects | |
restorations.ports.fixed_ips.ip_address |
any | IP address to assign to the port |
restorations.ports.fixed_ips.subnet_id |
string | ID of the subnet in which to assign the IP address |
restorations.ports.mac_address |
string | MAC address of the port |
restorations.ports.subnet |
string (uri) | Subnet to which this port belongs |
restorations.ports.subnet_uuid |
string (uuid) | |
restorations.ports.subnet_name |
string | |
restorations.ports.subnet_description |
string | |
restorations.ports.subnet_cidr |
string | IPv4 network address in CIDR format (e.g. 192.168.0.0/24) |
restorations.ports.allowed_address_pairs |
array of objects | |
restorations.ports.allowed_address_pairs.mac_address |
string | |
restorations.ports.device_id |
string | ID of device (instance, router etc) to which this port is connected |
restorations.ports.device_owner |
string | Entity that uses this port (e.g. network:router_interface) |
restorations.ports.security_groups |
array of objects | |
restorations.ports.security_groups.url |
string (uri) | |
restorations.ports.security_groups.uuid |
string (uuid) | |
restorations.ports.security_groups.name |
string | |
restorations.ports.security_groups.description |
string | |
restorations.ports.security_groups.service_name |
string | |
restorations.ports.security_groups.service_settings |
string (uri) | |
restorations.ports.security_groups.service_settings_uuid |
string (uuid) | |
restorations.ports.security_groups.service_settings_state |
string | |
restorations.ports.security_groups.service_settings_error_message |
string | |
restorations.ports.security_groups.project |
string (uri) | |
restorations.ports.security_groups.project_name |
string | |
restorations.ports.security_groups.project_uuid |
string (uuid) | |
restorations.ports.security_groups.customer |
string (uri) | |
restorations.ports.security_groups.customer_uuid |
string (uuid) | |
restorations.ports.security_groups.customer_name |
string | |
restorations.ports.security_groups.customer_native_name |
string | |
restorations.ports.security_groups.customer_abbreviation |
string | |
restorations.ports.security_groups.error_message |
string | |
restorations.ports.security_groups.error_traceback |
string | |
restorations.ports.security_groups.resource_type |
string | |
restorations.ports.security_groups.state |
any | |
restorations.ports.security_groups.created |
string (date-time) | |
restorations.ports.security_groups.modified |
string (date-time) | |
restorations.ports.security_groups.backend_id |
string | |
restorations.ports.security_groups.access_url |
string | |
restorations.ports.security_groups.tenant |
string (uri) | |
restorations.ports.security_groups.tenant_name |
string | |
restorations.ports.security_groups.tenant_uuid |
string (uuid) | |
restorations.ports.security_groups.rules |
array of objects | |
restorations.ports.security_groups.rules.ethertype |
any | IP protocol version - either 'IPv4' or 'IPv6' |
restorations.ports.security_groups.rules.direction |
any | Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing) |
restorations.ports.security_groups.rules.protocol |
any | The network protocol (TCP, UDP, ICMP, or empty for any protocol) |
restorations.ports.security_groups.rules.from_port |
integer | Starting port number in the range (1-65535) |
restorations.ports.security_groups.rules.to_port |
integer | Ending port number in the range (1-65535) |
restorations.ports.security_groups.rules.cidr |
string | CIDR notation for the source/destination network address range |
restorations.ports.security_groups.rules.description |
string | |
restorations.ports.security_groups.rules.remote_group_name |
string | |
restorations.ports.security_groups.rules.remote_group_uuid |
string (uuid) | |
restorations.ports.security_groups.rules.id |
integer | |
restorations.ports.security_groups.rules.remote_group |
string (uri) | Remote security group that this rule references, if any |
restorations.ports.security_groups.marketplace_offering_uuid |
string | |
restorations.ports.security_groups.marketplace_offering_name |
string | |
restorations.ports.security_groups.marketplace_offering_plugin_options |
object (free-form) | |
restorations.ports.security_groups.marketplace_category_uuid |
string | |
restorations.ports.security_groups.marketplace_category_name |
string | |
restorations.ports.security_groups.marketplace_resource_uuid |
string | |
restorations.ports.security_groups.marketplace_plan_uuid |
string | |
restorations.ports.security_groups.marketplace_resource_state |
string | |
restorations.ports.security_groups.is_usage_based |
boolean | |
restorations.ports.security_groups.is_limit_based |
boolean | |
instance_security_groups |
array of objects | |
instance_security_groups.url |
string (uri) | |
instance_security_groups.name |
string | |
instance_security_groups.rules |
array of objects | |
instance_security_groups.rules.ethertype |
any | IP protocol version - either 'IPv4' or 'IPv6' |
instance_security_groups.rules.direction |
any | Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing) |
instance_security_groups.rules.protocol |
any | The network protocol (TCP, UDP, ICMP, or empty for any protocol) |
instance_security_groups.rules.from_port |
integer | Starting port number in the range (1-65535) |
instance_security_groups.rules.to_port |
integer | Ending port number in the range (1-65535) |
instance_security_groups.rules.cidr |
string | CIDR notation for the source/destination network address range |
instance_security_groups.rules.description |
string | |
instance_security_groups.rules.remote_group_name |
string | |
instance_security_groups.rules.remote_group_uuid |
string (uuid) | |
instance_security_groups.rules.id |
integer | |
instance_security_groups.description |
string | |
instance_security_groups.state |
string | |
instance_ports |
array of objects | |
instance_ports.url |
string (uri) | |
instance_ports.fixed_ips |
array of objects | |
instance_ports.fixed_ips.ip_address |
any | IP address to assign to the port |
instance_ports.fixed_ips.subnet_id |
string | ID of the subnet in which to assign the IP address |
instance_ports.mac_address |
string | MAC address of the port |
instance_ports.subnet |
string (uri) | Subnet to which this port belongs |
instance_ports.subnet_uuid |
string (uuid) | |
instance_ports.subnet_name |
string | |
instance_ports.subnet_description |
string | |
instance_ports.subnet_cidr |
string | IPv4 network address in CIDR format (e.g. 192.168.0.0/24) |
instance_ports.allowed_address_pairs |
array of objects | |
instance_ports.allowed_address_pairs.mac_address |
string | |
instance_ports.device_id |
string | ID of device (instance, router etc) to which this port is connected |
instance_ports.device_owner |
string | Entity that uses this port (e.g. network:router_interface) |
instance_ports.security_groups |
array of objects | |
instance_ports.security_groups.url |
string (uri) | |
instance_ports.security_groups.uuid |
string (uuid) | |
instance_ports.security_groups.name |
string | |
instance_ports.security_groups.description |
string | |
instance_ports.security_groups.service_name |
string | |
instance_ports.security_groups.service_settings |
string (uri) | |
instance_ports.security_groups.service_settings_uuid |
string (uuid) | |
instance_ports.security_groups.service_settings_state |
string | |
instance_ports.security_groups.service_settings_error_message |
string | |
instance_ports.security_groups.project |
string (uri) | |
instance_ports.security_groups.project_name |
string | |
instance_ports.security_groups.project_uuid |
string (uuid) | |
instance_ports.security_groups.customer |
string (uri) | |
instance_ports.security_groups.customer_uuid |
string (uuid) | |
instance_ports.security_groups.customer_name |
string | |
instance_ports.security_groups.customer_native_name |
string | |
instance_ports.security_groups.customer_abbreviation |
string | |
instance_ports.security_groups.error_message |
string | |
instance_ports.security_groups.error_traceback |
string | |
instance_ports.security_groups.resource_type |
string | |
instance_ports.security_groups.state |
any | |
instance_ports.security_groups.created |
string (date-time) | |
instance_ports.security_groups.modified |
string (date-time) | |
instance_ports.security_groups.backend_id |
string | |
instance_ports.security_groups.access_url |
string | |
instance_ports.security_groups.tenant |
string (uri) | |
instance_ports.security_groups.tenant_name |
string | |
instance_ports.security_groups.tenant_uuid |
string (uuid) | |
instance_ports.security_groups.rules |
array of objects | |
instance_ports.security_groups.rules.ethertype |
any | IP protocol version - either 'IPv4' or 'IPv6' |
instance_ports.security_groups.rules.direction |
any | Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing) |
instance_ports.security_groups.rules.protocol |
any | The network protocol (TCP, UDP, ICMP, or empty for any protocol) |
instance_ports.security_groups.rules.from_port |
integer | Starting port number in the range (1-65535) |
instance_ports.security_groups.rules.to_port |
integer | Ending port number in the range (1-65535) |
instance_ports.security_groups.rules.cidr |
string | CIDR notation for the source/destination network address range |
instance_ports.security_groups.rules.description |
string | |
instance_ports.security_groups.rules.remote_group_name |
string | |
instance_ports.security_groups.rules.remote_group_uuid |
string (uuid) | |
instance_ports.security_groups.rules.id |
integer | |
instance_ports.security_groups.rules.remote_group |
string (uri) | Remote security group that this rule references, if any |
instance_ports.security_groups.marketplace_offering_uuid |
string | |
instance_ports.security_groups.marketplace_offering_name |
string | |
instance_ports.security_groups.marketplace_offering_plugin_options |
object (free-form) | |
instance_ports.security_groups.marketplace_category_uuid |
string | |
instance_ports.security_groups.marketplace_category_name |
string | |
instance_ports.security_groups.marketplace_resource_uuid |
string | |
instance_ports.security_groups.marketplace_plan_uuid |
string | |
instance_ports.security_groups.marketplace_resource_state |
string | |
instance_ports.security_groups.is_usage_based |
boolean | |
instance_ports.security_groups.is_limit_based |
boolean | |
instance_floating_ips |
array of objects | |
instance_floating_ips.url |
string (uri) | |
instance_floating_ips.uuid |
string (uuid) | |
instance_floating_ips.address |
any | The public IPv4 address of the floating IP |
instance_floating_ips.port_fixed_ips |
array of objects | |
instance_floating_ips.port_fixed_ips.ip_address |
any | IP address to assign to the port |
instance_floating_ips.port_fixed_ips.subnet_id |
string | ID of the subnet in which to assign the IP address |
instance_floating_ips.port_mac_address |
string | MAC address of the port |
instance_floating_ips.subnet |
string (uri) | |
instance_floating_ips.subnet_uuid |
string (uuid) | |
instance_floating_ips.subnet_name |
string | |
instance_floating_ips.subnet_description |
string | |
instance_floating_ips.subnet_cidr |
string | IPv4 network address in CIDR format (e.g. 192.168.0.0/24) |
tenant_uuid |
string (uuid) | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Delete backup
Delete an instance backup.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_backups_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
Restore instance from backup
Restore instance from backup
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
OpenStackBackupRestorationCreateRequest - API Source:
openstack_backups_restore
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
flavor |
string (uri) | ✓ | Flavor to be used for the restored instance. If not specified, original instance flavor will be used |
name |
string | New instance name. Leave blank to use source instance name. | |
floating_ips |
array of objects | Floating IPs that will be assigned to the restored instance | |
floating_ips.url |
string (uri) | ||
floating_ips.ip_address |
any | Existing floating IP address in selected OpenStack tenant to be assigned to new virtual machine | |
floating_ips.subnet |
string (uri) | ✓ | |
security_groups |
array of objects | Security groups that will be assigned to the restored instance | |
security_groups.url |
string (uri) | ✓ | |
ports |
array of objects | Network ports that will be attached to the restored instance | |
ports.fixed_ips |
array of objects | ||
ports.fixed_ips.ip_address |
any | ✓ | IP address to assign to the port |
ports.fixed_ips.subnet_id |
string | ✓ | ID of the subnet in which to assign the IP address |
ports.subnet |
string (uri) | Subnet to which this port belongs | |
ports.port |
string (uri) | ||
ports.tenant |
string (uri) | Target tenant for port creation. If not specified, uses subnet's tenant. Constraints: write-only |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | OpenStack provider settings |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | Instance ID in the OpenStack backend |
access_url |
string | |
start_time |
string (date-time) | |
cores |
integer | Number of cores in a VM |
ram |
integer | Memory size in MiB |
disk |
integer | Disk size in MiB |
min_ram |
integer | Minimum memory size in MiB |
min_disk |
integer | Minimum disk size in MiB |
user_data |
string | Additional data that will be added to instance on provisioning |
external_ips |
array of string (ipv4)s | |
internal_ips |
array of string (ipv4)s | |
latitude |
number (double) | |
longitude |
number (double) | |
key_name |
string | |
key_fingerprint |
string | |
image_name |
string | |
flavor_disk |
integer | Flavor disk size in MiB |
flavor_name |
string | Name of the flavor used by this instance |
volumes |
array of objects | List of volumes attached to the instance |
volumes.url |
string (uri) | |
volumes.uuid |
string (uuid) | |
volumes.name |
string | |
volumes.image_name |
string | Name of the image this volume was created from |
volumes.state |
string | |
volumes.bootable |
boolean | Indicates if this volume can be used to boot an instance |
volumes.size |
integer | Size in MiB |
volumes.device |
string | Name of volume as instance device e.g. /dev/vdb. |
volumes.resource_type |
string | |
volumes.type |
string (uri) | Type of the volume (e.g. SSD, HDD) |
volumes.type_name |
string | |
volumes.marketplace_resource_uuid |
string | |
security_groups |
array of objects | |
security_groups.url |
string (uri) | |
security_groups.name |
string | |
security_groups.rules |
array of objects | |
security_groups.rules.ethertype |
any | IP protocol version - either 'IPv4' or 'IPv6' |
security_groups.rules.direction |
any | Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing) |
security_groups.rules.protocol |
any | The network protocol (TCP, UDP, ICMP, or empty for any protocol) |
security_groups.rules.from_port |
integer | Starting port number in the range (1-65535) |
security_groups.rules.to_port |
integer | Ending port number in the range (1-65535) |
security_groups.rules.cidr |
string | CIDR notation for the source/destination network address range |
security_groups.rules.description |
string | |
security_groups.rules.remote_group_name |
string | |
security_groups.rules.remote_group_uuid |
string (uuid) | |
security_groups.rules.id |
integer | |
security_groups.description |
string | |
security_groups.state |
string | |
server_group |
object | |
server_group.url |
string (uri) | |
server_group.name |
string | |
server_group.policy |
any | Server group policy determining the rules for scheduling servers in this group |
server_group.state |
string | |
floating_ips |
array of objects | |
floating_ips.url |
string (uri) | |
floating_ips.uuid |
string (uuid) | |
floating_ips.address |
any | The public IPv4 address of the floating IP |
floating_ips.port_fixed_ips |
array of objects | |
floating_ips.port_fixed_ips.ip_address |
any | IP address to assign to the port |
floating_ips.port_fixed_ips.subnet_id |
string | ID of the subnet in which to assign the IP address |
floating_ips.port_mac_address |
string | MAC address of the port |
floating_ips.subnet |
string (uri) | |
floating_ips.subnet_uuid |
string (uuid) | |
floating_ips.subnet_name |
string | |
floating_ips.subnet_description |
string | |
floating_ips.subnet_cidr |
string | IPv4 network address in CIDR format (e.g. 192.168.0.0/24) |
ports |
array of objects | |
ports.url |
string (uri) | |
ports.fixed_ips |
array of objects | |
ports.fixed_ips.ip_address |
any | IP address to assign to the port |
ports.fixed_ips.subnet_id |
string | ID of the subnet in which to assign the IP address |
ports.mac_address |
string | MAC address of the port |
ports.subnet |
string (uri) | Subnet to which this port belongs |
ports.subnet_uuid |
string (uuid) | |
ports.subnet_name |
string | |
ports.subnet_description |
string | |
ports.subnet_cidr |
string | IPv4 network address in CIDR format (e.g. 192.168.0.0/24) |
ports.allowed_address_pairs |
array of objects | |
ports.allowed_address_pairs.mac_address |
string | |
ports.device_id |
string | ID of device (instance, router etc) to which this port is connected |
ports.device_owner |
string | Entity that uses this port (e.g. network:router_interface) |
ports.security_groups |
array of objects | |
ports.security_groups.url |
string (uri) | |
ports.security_groups.uuid |
string (uuid) | |
ports.security_groups.name |
string | |
ports.security_groups.description |
string | |
ports.security_groups.service_name |
string | |
ports.security_groups.service_settings |
string (uri) | |
ports.security_groups.service_settings_uuid |
string (uuid) | |
ports.security_groups.service_settings_state |
string | |
ports.security_groups.service_settings_error_message |
string | |
ports.security_groups.project |
string (uri) | |
ports.security_groups.project_name |
string | |
ports.security_groups.project_uuid |
string (uuid) | |
ports.security_groups.customer |
string (uri) | |
ports.security_groups.customer_uuid |
string (uuid) | |
ports.security_groups.customer_name |
string | |
ports.security_groups.customer_native_name |
string | |
ports.security_groups.customer_abbreviation |
string | |
ports.security_groups.error_message |
string | |
ports.security_groups.error_traceback |
string | |
ports.security_groups.resource_type |
string | |
ports.security_groups.state |
any | |
ports.security_groups.created |
string (date-time) | |
ports.security_groups.modified |
string (date-time) | |
ports.security_groups.backend_id |
string | |
ports.security_groups.access_url |
string | |
ports.security_groups.tenant |
string (uri) | |
ports.security_groups.tenant_name |
string | |
ports.security_groups.tenant_uuid |
string (uuid) | |
ports.security_groups.rules |
array of objects | |
ports.security_groups.rules.ethertype |
any | IP protocol version - either 'IPv4' or 'IPv6' |
ports.security_groups.rules.direction |
any | Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing) |
ports.security_groups.rules.protocol |
any | The network protocol (TCP, UDP, ICMP, or empty for any protocol) |
ports.security_groups.rules.from_port |
integer | Starting port number in the range (1-65535) |
ports.security_groups.rules.to_port |
integer | Ending port number in the range (1-65535) |
ports.security_groups.rules.cidr |
string | CIDR notation for the source/destination network address range |
ports.security_groups.rules.description |
string | |
ports.security_groups.rules.remote_group_name |
string | |
ports.security_groups.rules.remote_group_uuid |
string (uuid) | |
ports.security_groups.rules.id |
integer | |
ports.security_groups.rules.remote_group |
string (uri) | Remote security group that this rule references, if any |
ports.security_groups.marketplace_offering_uuid |
string | |
ports.security_groups.marketplace_offering_name |
string | |
ports.security_groups.marketplace_offering_plugin_options |
object (free-form) | |
ports.security_groups.marketplace_category_uuid |
string | |
ports.security_groups.marketplace_category_name |
string | |
ports.security_groups.marketplace_resource_uuid |
string | |
ports.security_groups.marketplace_plan_uuid |
string | |
ports.security_groups.marketplace_resource_state |
string | |
ports.security_groups.is_usage_based |
boolean | |
ports.security_groups.is_limit_based |
boolean | |
availability_zone |
string (uri) | Availability zone where this instance is located |
availability_zone_name |
string | Name of the availability zone where instance is located |
connect_directly_to_external_network |
boolean | If True, instance will be connected directly to external network |
runtime_state |
string | |
action |
string | |
action_details |
any | Details about ongoing or completed actions |
tenant_uuid |
string (uuid) | UUID of the OpenStack tenant |
hypervisor_hostname |
string | Name of the hypervisor hosting this instance |
tenant |
string (uri) | The OpenStack tenant to create the instance in |
external_address |
array of strings | |
rancher_cluster |
any | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Mark resource as ERRED
Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
SetErredRequest - API Source:
openstack_backups_set_erred
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
error_message |
string | |
error_traceback |
string |
200 -
| Field | Type |
|---|---|
detail |
string |
Mark resource as OK
Manually transition the resource to OK state and clear error fields. Staff-only operation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_backups_set_ok
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
detail |
string |
Openstack External Networks
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/openstack-external-networks/ |
List external networks |
| GET | /api/openstack-external-networks/{uuid}/ |
Get external network details |
List external networks
Get a list of provider-level external networks discovered from OpenStack.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 | |
- Model Source:
ExternalNetworkFieldEnum - API Source:
openstack_external_networks_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
field |
array | |
name |
string | Name |
name_exact |
string | Name (exact) |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
settings |
string (uri) | Settings URL |
settings_uuid |
string (uuid) | Settings UUID |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
settings |
string (uri) | |
backend_id |
string | |
is_shared |
boolean | |
is_default |
boolean | |
status |
string | |
description |
string | |
subnets |
array of objects | |
subnets.uuid |
string (uuid) | |
subnets.name |
string | |
subnets.backend_id |
string | |
subnets.cidr |
string | |
subnets.gateway_ip |
any | An IPv4 or IPv6 address. |
subnets.ip_version |
integer | |
subnets.enable_dhcp |
boolean | |
subnets.allocation_pools |
any | |
subnets.dns_nameservers |
any | |
subnets.public_ip_range |
string | Public CIDR mapped to this subnet (for carrier-grade NAT overlay) |
subnets.description |
string |
Get external network details
Retrieve details of a specific external network, including its subnets.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
ExternalNetworkFieldEnum - API Source:
openstack_external_networks_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
settings |
string (uri) | |
backend_id |
string | |
is_shared |
boolean | |
is_default |
boolean | |
status |
string | |
description |
string | |
subnets |
array of objects | |
subnets.uuid |
string (uuid) | |
subnets.name |
string | |
subnets.backend_id |
string | |
subnets.cidr |
string | |
subnets.gateway_ip |
any | An IPv4 or IPv6 address. |
subnets.ip_version |
integer | |
subnets.enable_dhcp |
boolean | |
subnets.allocation_pools |
any | |
subnets.dns_nameservers |
any | |
subnets.public_ip_range |
string | Public CIDR mapped to this subnet (for carrier-grade NAT overlay) |
subnets.description |
string |
Openstack Flavors
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/openstack-flavors/ |
List flavors |
| GET | /api/openstack-flavors/{uuid}/ |
Get flavor details |
| Other Actions | ||
| GET | /api/openstack-flavors/usage_stats/ |
Get flavor usage statistics |
Core CRUD
List flavors
Get a list of available VM instance flavors.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- Model Source:
OpenStackFlavorFieldEnum - Model Source:
OpenStackFlavorOEnum - API Source:
openstack_flavors_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
cores |
integer | |
cores__gte |
integer | |
cores__lte |
integer | |
disk |
integer | |
disk__gte |
integer | |
disk__lte |
integer | |
field |
array | |
name |
string | Name |
name_exact |
string | Name (exact) |
name_iregex |
string | Name (regex) |
o |
array | Ordering |
offering_uuid |
string (uuid) | Offering UUID |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
ram |
integer | |
ram__gte |
integer | |
ram__lte |
integer | |
settings |
string (uri) | Settings URL |
settings_uuid |
string (uuid) | Settings UUID |
tenant |
string (uri) | Tenant URL |
tenant_uuid |
string (uuid) | Tenant UUID |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
settings |
string (uri) | |
cores |
integer | Number of cores in a VM |
ram |
integer | Memory size in MiB |
disk |
integer | Root disk size in MiB |
backend_id |
string | |
display_name |
string |
Get flavor details
Retrieve details of a specific VM instance flavor.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
OpenStackFlavorFieldEnum - API Source:
openstack_flavors_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
settings |
string (uri) | |
cores |
integer | Number of cores in a VM |
ram |
integer | Memory size in MiB |
disk |
integer | Root disk size in MiB |
backend_id |
string | |
display_name |
string |
Other Actions
Get flavor usage statistics
Retrieve usage statistics for VM instance flavors, showing running and created instance counts for each flavor.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- Model Source:
OpenStackFlavorFieldEnum - API Source:
openstack_flavors_usage_stats_retrieve
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
settings |
string (uri) | |
cores |
integer | Number of cores in a VM |
ram |
integer | Memory size in MiB |
disk |
integer | Root disk size in MiB |
backend_id |
string | |
display_name |
string |
Openstack Floating Ips
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/openstack-floating-ips/ |
List floating IPs |
| GET | /api/openstack-floating-ips/{uuid}/ |
Get floating IP details |
| POST | /api/openstack-floating-ips/{uuid}/pull/ |
Synchronize resource state |
| POST | /api/openstack-floating-ips/{uuid}/unlink/ |
Unlink resource |
| POST | /api/openstack-floating-ips/{uuid}/update_description/ |
Update floating IP description |
| DELETE | /api/openstack-floating-ips/{uuid}/ |
Delete floating IP |
| Other Actions | ||
| POST | /api/openstack-floating-ips/{uuid}/attach_to_port/ |
Attach floating IP to a port |
| POST | /api/openstack-floating-ips/{uuid}/detach_from_port/ |
Detach floating IP from port |
| POST | /api/openstack-floating-ips/{uuid}/set_erred/ |
Mark resource as ERRED |
| POST | /api/openstack-floating-ips/{uuid}/set_ok/ |
Mark resource as OK |
Core CRUD
List floating IPs
Get a list of floating IP addresses. Status DOWN means that floating IP is not linked to a VM, status ACTIVE means that it is in use.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- Model Source:
CoreStates - Model Source:
OpenStackFloatingIPFieldEnum - API Source:
openstack_floating_ips_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
address |
string | |
backend_id |
string | Backend ID |
can_manage |
boolean | Can manage |
customer |
string (uuid) | Customer UUID |
customer_abbreviation |
string | Customer abbreviation |
customer_name |
string | Customer name |
customer_native_name |
string | Customer native name |
customer_uuid |
string (uuid) | Customer UUID |
description |
string | Description |
external_ip |
string | External IP |
field |
array | |
free |
boolean | Is free |
name |
string | Name |
name_exact |
string | Name (exact) |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
project |
string (uuid) | Project UUID |
project_name |
string | Project name |
project_uuid |
string (uuid) | Project UUID |
runtime_state |
string | |
service_settings_name |
string | Service settings name |
service_settings_uuid |
string (uuid) | Service settings UUID |
state |
array | State |
tenant |
string (uri) | Tenant URL |
tenant_uuid |
string (uuid) | Tenant UUID |
uuid |
string (uuid) | UUID |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
runtime_state |
string | |
address |
any | The public IPv4 address of the floating IP |
backend_network_id |
string | ID of network in OpenStack where this floating IP is allocated |
tenant |
string (uri) | OpenStack tenant this floating IP belongs to |
tenant_name |
string | |
tenant_uuid |
string (uuid) | |
port |
string (uri) | |
external_address |
any | Optional address that maps to floating IP's address in external networks |
port_fixed_ips |
array of objects | |
port_fixed_ips.ip_address |
any | IP address to assign to the port |
port_fixed_ips.subnet_id |
string | ID of the subnet in which to assign the IP address |
instance_uuid |
string | |
instance_name |
string | |
instance_url |
string | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Get floating IP details
Retrieve details of a specific floating IP address.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
OpenStackFloatingIPFieldEnum - API Source:
openstack_floating_ips_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
runtime_state |
string | |
address |
any | The public IPv4 address of the floating IP |
backend_network_id |
string | ID of network in OpenStack where this floating IP is allocated |
tenant |
string (uri) | OpenStack tenant this floating IP belongs to |
tenant_name |
string | |
tenant_uuid |
string (uuid) | |
port |
string (uri) | |
external_address |
any | Optional address that maps to floating IP's address in external networks |
port_fixed_ips |
array of objects | |
port_fixed_ips.ip_address |
any | IP address to assign to the port |
port_fixed_ips.subnet_id |
string | ID of the subnet in which to assign the IP address |
instance_uuid |
string | |
instance_name |
string | |
instance_url |
string | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Synchronize resource state
Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_floating_ips_pull
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
202 -
| Field | Type |
|---|---|
detail |
string |
409 -
| Field | Type |
|---|---|
detail |
string |
Unlink resource
Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_floating_ips_unlink
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Update floating IP description
Update description of the floating IP
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
OpenStackFloatingIPDescriptionUpdateRequest - API Source:
openstack_floating_ips_update_description
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
description |
string | New floating IP description. |
200 - No response body
Delete floating IP
Delete a floating IP address.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_floating_ips_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
Attach floating IP to a port
Attach floating IP to port
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
OpenStackFloatingIPAttachRequest - API Source:
openstack_floating_ips_attach_to_port
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
port |
string (uri) | ✓ |
200 - No response body
Detach floating IP from port
Detach floating IP from port
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_floating_ips_detach_from_port
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - No response body
Mark resource as ERRED
Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
SetErredRequest - API Source:
openstack_floating_ips_set_erred
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
error_message |
string | |
error_traceback |
string |
200 -
| Field | Type |
|---|---|
detail |
string |
Mark resource as OK
Manually transition the resource to OK state and clear error fields. Staff-only operation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_floating_ips_set_ok
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
detail |
string |
Openstack Images
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/openstack-images/ |
List images |
| GET | /api/openstack-images/{uuid}/ |
Get image details |
| Other Actions | ||
| GET | /api/openstack-images/usage_stats/ |
Get image usage statistics |
Core CRUD
List images
Get a list of available VM instance images.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
openstack_images_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
name |
string | Name |
name_exact |
string | Name (exact) |
offering_uuid |
string (uuid) | Offering UUID |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
settings |
string (uri) | Settings URL |
settings_uuid |
string (uuid) | Settings UUID |
show_duplicate_names |
boolean | Show duplicate image names |
tenant |
string (uri) | Tenant URL |
tenant_uuid |
string (uuid) | Tenant UUID |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
min_disk |
integer | Minimum disk size in MiB |
min_ram |
integer | Minimum memory size in MiB |
settings |
string (uri) | |
backend_id |
string | |
backend_created_at |
string (date-time) |
Get image details
Retrieve details of a specific VM instance image.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_images_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
min_disk |
integer | Minimum disk size in MiB |
min_ram |
integer | Minimum memory size in MiB |
settings |
string (uri) | |
backend_id |
string | |
backend_created_at |
string (date-time) |
Other Actions
Get image usage statistics
Retrieve usage statistics for VM instance images, showing running and created instance counts for each image.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
- API Source:
openstack_images_usage_stats_retrieve
1 2 3 4 5 6 7 8 9 10 | |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
min_disk |
integer | Minimum disk size in MiB |
min_ram |
integer | Minimum memory size in MiB |
settings |
string (uri) | |
backend_id |
string | |
backend_created_at |
string (date-time) |
Openstack Instance Availability Zones
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/openstack-instance-availability-zones/ |
List instance availability zones |
| GET | /api/openstack-instance-availability-zones/{uuid}/ |
Get instance availability zone details |
List instance availability zones
Get a list of instance availability zones.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
openstack_instance_availability_zones_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
name |
string | Name |
name_exact |
string | Name (exact) |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
settings |
string (uri) | Settings URL |
settings_uuid |
string (uuid) | Settings UUID |
tenant |
string (uri) | Tenant URL |
tenant_uuid |
string (uuid) | Tenant UUID |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
settings |
string (uri) | |
available |
boolean | Indicates whether this availability zone is available for instance provisioning |
Get instance availability zone details
Retrieve details of a specific instance availability zone.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_instance_availability_zones_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
settings |
string (uri) | |
available |
boolean | Indicates whether this availability zone is available for instance provisioning |
Openstack Instances
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/openstack-instances/ |
List instances |
| GET | /api/openstack-instances/{uuid}/ |
Get instance details |
| POST | /api/openstack-instances/{uuid}/pull/ |
Synchronize resource state |
| POST | /api/openstack-instances/{uuid}/unlink/ |
Unlink resource |
| PUT | /api/openstack-instances/{uuid}/ |
Update instance |
| PATCH | /api/openstack-instances/{uuid}/ |
Partially update instance |
| State Management | ||
| POST | /api/openstack-instances/{uuid}/restart/ |
Restart instance |
| POST | /api/openstack-instances/{uuid}/start/ |
Start instance |
| POST | /api/openstack-instances/{uuid}/stop/ |
Stop instance |
| Subresource Management | ||
| GET | /api/openstack-instances/{uuid}/console_log/ |
Get console log |
| GET | /api/openstack-instances/{uuid}/console/ |
Get console URL |
| GET | /api/openstack-instances/{uuid}/floating_ips/ |
List instance floating IPs |
| GET | /api/openstack-instances/{uuid}/ports/ |
List instance ports |
| POST | /api/openstack-instances/{uuid}/backup/ |
Create instance backup |
| POST | /api/openstack-instances/{uuid}/update_allowed_address_pairs/ |
Update instance allowed address pairs |
| POST | /api/openstack-instances/{uuid}/update_floating_ips/ |
Update instance floating IPs |
| POST | /api/openstack-instances/{uuid}/update_ports/ |
Update instance ports |
| POST | /api/openstack-instances/{uuid}/update_security_groups/ |
Update instance security groups |
| Other Actions | ||
| POST | /api/openstack-instances/{uuid}/change_flavor/ |
Change instance flavor |
| POST | /api/openstack-instances/{uuid}/set_erred/ |
Mark resource as ERRED |
| POST | /api/openstack-instances/{uuid}/set_ok/ |
Mark resource as OK |
Core CRUD
List instances
Get a list of VM instances.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
CoreStates - Model Source:
OpenStackInstanceFieldEnum - Model Source:
OpenStackInstanceOEnum - API Source:
openstack_instances_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
attach_volume_uuid |
string (uuid) | Filter for attachment to volume UUID |
availability_zone_name |
string | Availability zone name |
backend_id |
string | Backend ID |
can_manage |
boolean | Can manage |
customer |
string (uuid) | Customer UUID |
customer_abbreviation |
string | Customer abbreviation |
customer_name |
string | Customer name |
customer_native_name |
string | Customer native name |
customer_uuid |
string (uuid) | Customer UUID |
description |
string | Description |
external_ip |
string | External IP |
field |
array | |
name |
string | Name |
name_exact |
string | Name (exact) |
o |
string | Ordering. Sort by start time. Enum: start_time, -start_time |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
project |
string (uuid) | Project UUID |
project_name |
string | Project name |
project_uuid |
string (uuid) | Project UUID |
query |
string | Search by name, internal IP, or external IP |
runtime_state |
string | |
service_settings_name |
string | Service settings name |
service_settings_uuid |
string (uuid) | Service settings UUID |
state |
array | State |
tenant |
string (uri) | Tenant URL |
tenant_uuid |
string (uuid) | Tenant UUID |
uuid |
string (uuid) | UUID |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | OpenStack provider settings |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | Instance ID in the OpenStack backend |
access_url |
string | |
start_time |
string (date-time) | |
cores |
integer | Number of cores in a VM |
ram |
integer | Memory size in MiB |
disk |
integer | Disk size in MiB |
min_ram |
integer | Minimum memory size in MiB |
min_disk |
integer | Minimum disk size in MiB |
user_data |
string | Additional data that will be added to instance on provisioning |
external_ips |
array of string (ipv4)s | |
internal_ips |
array of string (ipv4)s | |
latitude |
number (double) | |
longitude |
number (double) | |
key_name |
string | |
key_fingerprint |
string | |
image_name |
string | |
flavor_disk |
integer | Flavor disk size in MiB |
flavor_name |
string | Name of the flavor used by this instance |
volumes |
array of objects | List of volumes attached to the instance |
volumes.url |
string (uri) | |
volumes.uuid |
string (uuid) | |
volumes.name |
string | |
volumes.image_name |
string | Name of the image this volume was created from |
volumes.state |
string | |
volumes.bootable |
boolean | Indicates if this volume can be used to boot an instance |
volumes.size |
integer | Size in MiB |
volumes.device |
string | Name of volume as instance device e.g. /dev/vdb. |
volumes.resource_type |
string | |
volumes.type |
string (uri) | Type of the volume (e.g. SSD, HDD) |
volumes.type_name |
string | |
volumes.marketplace_resource_uuid |
string | |
security_groups |
array of objects | |
security_groups.url |
string (uri) | |
security_groups.name |
string | |
security_groups.rules |
array of objects | |
security_groups.rules.ethertype |
any | IP protocol version - either 'IPv4' or 'IPv6' |
security_groups.rules.direction |
any | Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing) |
security_groups.rules.protocol |
any | The network protocol (TCP, UDP, ICMP, or empty for any protocol) |
security_groups.rules.from_port |
integer | Starting port number in the range (1-65535) |
security_groups.rules.to_port |
integer | Ending port number in the range (1-65535) |
security_groups.rules.cidr |
string | CIDR notation for the source/destination network address range |
security_groups.rules.description |
string | |
security_groups.rules.remote_group_name |
string | |
security_groups.rules.remote_group_uuid |
string (uuid) | |
security_groups.rules.id |
integer | |
security_groups.description |
string | |
security_groups.state |
string | |
server_group |
object | |
server_group.url |
string (uri) | |
server_group.name |
string | |
server_group.policy |
any | Server group policy determining the rules for scheduling servers in this group |
server_group.state |
string | |
floating_ips |
array of objects | |
floating_ips.url |
string (uri) | |
floating_ips.uuid |
string (uuid) | |
floating_ips.address |
any | The public IPv4 address of the floating IP |
floating_ips.port_fixed_ips |
array of objects | |
floating_ips.port_fixed_ips.ip_address |
any | IP address to assign to the port |
floating_ips.port_fixed_ips.subnet_id |
string | ID of the subnet in which to assign the IP address |
floating_ips.port_mac_address |
string | MAC address of the port |
floating_ips.subnet |
string (uri) | |
floating_ips.subnet_uuid |
string (uuid) | |
floating_ips.subnet_name |
string | |
floating_ips.subnet_description |
string | |
floating_ips.subnet_cidr |
string | IPv4 network address in CIDR format (e.g. 192.168.0.0/24) |
ports |
array of objects | |
ports.url |
string (uri) | |
ports.fixed_ips |
array of objects | |
ports.fixed_ips.ip_address |
any | IP address to assign to the port |
ports.fixed_ips.subnet_id |
string | ID of the subnet in which to assign the IP address |
ports.mac_address |
string | MAC address of the port |
ports.subnet |
string (uri) | Subnet to which this port belongs |
ports.subnet_uuid |
string (uuid) | |
ports.subnet_name |
string | |
ports.subnet_description |
string | |
ports.subnet_cidr |
string | IPv4 network address in CIDR format (e.g. 192.168.0.0/24) |
ports.allowed_address_pairs |
array of objects | |
ports.allowed_address_pairs.mac_address |
string | |
ports.device_id |
string | ID of device (instance, router etc) to which this port is connected |
ports.device_owner |
string | Entity that uses this port (e.g. network:router_interface) |
ports.security_groups |
array of objects | |
ports.security_groups.url |
string (uri) | |
ports.security_groups.uuid |
string (uuid) | |
ports.security_groups.name |
string | |
ports.security_groups.description |
string | |
ports.security_groups.service_name |
string | |
ports.security_groups.service_settings |
string (uri) | |
ports.security_groups.service_settings_uuid |
string (uuid) | |
ports.security_groups.service_settings_state |
string | |
ports.security_groups.service_settings_error_message |
string | |
ports.security_groups.project |
string (uri) | |
ports.security_groups.project_name |
string | |
ports.security_groups.project_uuid |
string (uuid) | |
ports.security_groups.customer |
string (uri) | |
ports.security_groups.customer_uuid |
string (uuid) | |
ports.security_groups.customer_name |
string | |
ports.security_groups.customer_native_name |
string | |
ports.security_groups.customer_abbreviation |
string | |
ports.security_groups.error_message |
string | |
ports.security_groups.error_traceback |
string | |
ports.security_groups.resource_type |
string | |
ports.security_groups.state |
any | |
ports.security_groups.created |
string (date-time) | |
ports.security_groups.modified |
string (date-time) | |
ports.security_groups.backend_id |
string | |
ports.security_groups.access_url |
string | |
ports.security_groups.tenant |
string (uri) | |
ports.security_groups.tenant_name |
string | |
ports.security_groups.tenant_uuid |
string (uuid) | |
ports.security_groups.rules |
array of objects | |
ports.security_groups.rules.ethertype |
any | IP protocol version - either 'IPv4' or 'IPv6' |
ports.security_groups.rules.direction |
any | Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing) |
ports.security_groups.rules.protocol |
any | The network protocol (TCP, UDP, ICMP, or empty for any protocol) |
ports.security_groups.rules.from_port |
integer | Starting port number in the range (1-65535) |
ports.security_groups.rules.to_port |
integer | Ending port number in the range (1-65535) |
ports.security_groups.rules.cidr |
string | CIDR notation for the source/destination network address range |
ports.security_groups.rules.description |
string | |
ports.security_groups.rules.remote_group_name |
string | |
ports.security_groups.rules.remote_group_uuid |
string (uuid) | |
ports.security_groups.rules.id |
integer | |
ports.security_groups.rules.remote_group |
string (uri) | Remote security group that this rule references, if any |
ports.security_groups.marketplace_offering_uuid |
string | |
ports.security_groups.marketplace_offering_name |
string | |
ports.security_groups.marketplace_offering_plugin_options |
object (free-form) | |
ports.security_groups.marketplace_category_uuid |
string | |
ports.security_groups.marketplace_category_name |
string | |
ports.security_groups.marketplace_resource_uuid |
string | |
ports.security_groups.marketplace_plan_uuid |
string | |
ports.security_groups.marketplace_resource_state |
string | |
ports.security_groups.is_usage_based |
boolean | |
ports.security_groups.is_limit_based |
boolean | |
availability_zone |
string (uri) | Availability zone where this instance is located |
availability_zone_name |
string | Name of the availability zone where instance is located |
connect_directly_to_external_network |
boolean | If True, instance will be connected directly to external network |
runtime_state |
string | |
action |
string | |
action_details |
any | Details about ongoing or completed actions |
tenant_uuid |
string (uuid) | UUID of the OpenStack tenant |
hypervisor_hostname |
string | Name of the hypervisor hosting this instance |
tenant |
string (uri) | The OpenStack tenant to create the instance in |
external_address |
array of strings | |
rancher_cluster |
any | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Get instance details
Retrieve details of a specific VM instance.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
OpenStackInstanceFieldEnum - API Source:
openstack_instances_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | OpenStack provider settings |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | Instance ID in the OpenStack backend |
access_url |
string | |
start_time |
string (date-time) | |
cores |
integer | Number of cores in a VM |
ram |
integer | Memory size in MiB |
disk |
integer | Disk size in MiB |
min_ram |
integer | Minimum memory size in MiB |
min_disk |
integer | Minimum disk size in MiB |
user_data |
string | Additional data that will be added to instance on provisioning |
external_ips |
array of string (ipv4)s | |
internal_ips |
array of string (ipv4)s | |
latitude |
number (double) | |
longitude |
number (double) | |
key_name |
string | |
key_fingerprint |
string | |
image_name |
string | |
flavor_disk |
integer | Flavor disk size in MiB |
flavor_name |
string | Name of the flavor used by this instance |
volumes |
array of objects | List of volumes attached to the instance |
volumes.url |
string (uri) | |
volumes.uuid |
string (uuid) | |
volumes.name |
string | |
volumes.image_name |
string | Name of the image this volume was created from |
volumes.state |
string | |
volumes.bootable |
boolean | Indicates if this volume can be used to boot an instance |
volumes.size |
integer | Size in MiB |
volumes.device |
string | Name of volume as instance device e.g. /dev/vdb. |
volumes.resource_type |
string | |
volumes.type |
string (uri) | Type of the volume (e.g. SSD, HDD) |
volumes.type_name |
string | |
volumes.marketplace_resource_uuid |
string | |
security_groups |
array of objects | |
security_groups.url |
string (uri) | |
security_groups.name |
string | |
security_groups.rules |
array of objects | |
security_groups.rules.ethertype |
any | IP protocol version - either 'IPv4' or 'IPv6' |
security_groups.rules.direction |
any | Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing) |
security_groups.rules.protocol |
any | The network protocol (TCP, UDP, ICMP, or empty for any protocol) |
security_groups.rules.from_port |
integer | Starting port number in the range (1-65535) |
security_groups.rules.to_port |
integer | Ending port number in the range (1-65535) |
security_groups.rules.cidr |
string | CIDR notation for the source/destination network address range |
security_groups.rules.description |
string | |
security_groups.rules.remote_group_name |
string | |
security_groups.rules.remote_group_uuid |
string (uuid) | |
security_groups.rules.id |
integer | |
security_groups.description |
string | |
security_groups.state |
string | |
server_group |
object | |
server_group.url |
string (uri) | |
server_group.name |
string | |
server_group.policy |
any | Server group policy determining the rules for scheduling servers in this group |
server_group.state |
string | |
floating_ips |
array of objects | |
floating_ips.url |
string (uri) | |
floating_ips.uuid |
string (uuid) | |
floating_ips.address |
any | The public IPv4 address of the floating IP |
floating_ips.port_fixed_ips |
array of objects | |
floating_ips.port_fixed_ips.ip_address |
any | IP address to assign to the port |
floating_ips.port_fixed_ips.subnet_id |
string | ID of the subnet in which to assign the IP address |
floating_ips.port_mac_address |
string | MAC address of the port |
floating_ips.subnet |
string (uri) | |
floating_ips.subnet_uuid |
string (uuid) | |
floating_ips.subnet_name |
string | |
floating_ips.subnet_description |
string | |
floating_ips.subnet_cidr |
string | IPv4 network address in CIDR format (e.g. 192.168.0.0/24) |
ports |
array of objects | |
ports.url |
string (uri) | |
ports.fixed_ips |
array of objects | |
ports.fixed_ips.ip_address |
any | IP address to assign to the port |
ports.fixed_ips.subnet_id |
string | ID of the subnet in which to assign the IP address |
ports.mac_address |
string | MAC address of the port |
ports.subnet |
string (uri) | Subnet to which this port belongs |
ports.subnet_uuid |
string (uuid) | |
ports.subnet_name |
string | |
ports.subnet_description |
string | |
ports.subnet_cidr |
string | IPv4 network address in CIDR format (e.g. 192.168.0.0/24) |
ports.allowed_address_pairs |
array of objects | |
ports.allowed_address_pairs.mac_address |
string | |
ports.device_id |
string | ID of device (instance, router etc) to which this port is connected |
ports.device_owner |
string | Entity that uses this port (e.g. network:router_interface) |
ports.security_groups |
array of objects | |
ports.security_groups.url |
string (uri) | |
ports.security_groups.uuid |
string (uuid) | |
ports.security_groups.name |
string | |
ports.security_groups.description |
string | |
ports.security_groups.service_name |
string | |
ports.security_groups.service_settings |
string (uri) | |
ports.security_groups.service_settings_uuid |
string (uuid) | |
ports.security_groups.service_settings_state |
string | |
ports.security_groups.service_settings_error_message |
string | |
ports.security_groups.project |
string (uri) | |
ports.security_groups.project_name |
string | |
ports.security_groups.project_uuid |
string (uuid) | |
ports.security_groups.customer |
string (uri) | |
ports.security_groups.customer_uuid |
string (uuid) | |
ports.security_groups.customer_name |
string | |
ports.security_groups.customer_native_name |
string | |
ports.security_groups.customer_abbreviation |
string | |
ports.security_groups.error_message |
string | |
ports.security_groups.error_traceback |
string | |
ports.security_groups.resource_type |
string | |
ports.security_groups.state |
any | |
ports.security_groups.created |
string (date-time) | |
ports.security_groups.modified |
string (date-time) | |
ports.security_groups.backend_id |
string | |
ports.security_groups.access_url |
string | |
ports.security_groups.tenant |
string (uri) | |
ports.security_groups.tenant_name |
string | |
ports.security_groups.tenant_uuid |
string (uuid) | |
ports.security_groups.rules |
array of objects | |
ports.security_groups.rules.ethertype |
any | IP protocol version - either 'IPv4' or 'IPv6' |
ports.security_groups.rules.direction |
any | Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing) |
ports.security_groups.rules.protocol |
any | The network protocol (TCP, UDP, ICMP, or empty for any protocol) |
ports.security_groups.rules.from_port |
integer | Starting port number in the range (1-65535) |
ports.security_groups.rules.to_port |
integer | Ending port number in the range (1-65535) |
ports.security_groups.rules.cidr |
string | CIDR notation for the source/destination network address range |
ports.security_groups.rules.description |
string | |
ports.security_groups.rules.remote_group_name |
string | |
ports.security_groups.rules.remote_group_uuid |
string (uuid) | |
ports.security_groups.rules.id |
integer | |
ports.security_groups.rules.remote_group |
string (uri) | Remote security group that this rule references, if any |
ports.security_groups.marketplace_offering_uuid |
string | |
ports.security_groups.marketplace_offering_name |
string | |
ports.security_groups.marketplace_offering_plugin_options |
object (free-form) | |
ports.security_groups.marketplace_category_uuid |
string | |
ports.security_groups.marketplace_category_name |
string | |
ports.security_groups.marketplace_resource_uuid |
string | |
ports.security_groups.marketplace_plan_uuid |
string | |
ports.security_groups.marketplace_resource_state |
string | |
ports.security_groups.is_usage_based |
boolean | |
ports.security_groups.is_limit_based |
boolean | |
availability_zone |
string (uri) | Availability zone where this instance is located |
availability_zone_name |
string | Name of the availability zone where instance is located |
connect_directly_to_external_network |
boolean | If True, instance will be connected directly to external network |
runtime_state |
string | |
action |
string | |
action_details |
any | Details about ongoing or completed actions |
tenant_uuid |
string (uuid) | UUID of the OpenStack tenant |
hypervisor_hostname |
string | Name of the hypervisor hosting this instance |
tenant |
string (uri) | The OpenStack tenant to create the instance in |
external_address |
array of strings | |
rancher_cluster |
any | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Synchronize resource state
Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_instances_pull
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
202 -
| Field | Type |
|---|---|
detail |
string |
409 -
| Field | Type |
|---|---|
detail |
string |
Unlink resource
Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_instances_unlink
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Update instance
Update an existing VM instance.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
OpenStackInstanceRequest - API Source:
openstack_instances_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
name |
string | ✓ |
description |
string |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | OpenStack provider settings |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | Instance ID in the OpenStack backend |
access_url |
string | |
start_time |
string (date-time) | |
cores |
integer | Number of cores in a VM |
ram |
integer | Memory size in MiB |
disk |
integer | Disk size in MiB |
min_ram |
integer | Minimum memory size in MiB |
min_disk |
integer | Minimum disk size in MiB |
user_data |
string | Additional data that will be added to instance on provisioning |
external_ips |
array of string (ipv4)s | |
internal_ips |
array of string (ipv4)s | |
latitude |
number (double) | |
longitude |
number (double) | |
key_name |
string | |
key_fingerprint |
string | |
image_name |
string | |
flavor_disk |
integer | Flavor disk size in MiB |
flavor_name |
string | Name of the flavor used by this instance |
volumes |
array of objects | List of volumes attached to the instance |
volumes.url |
string (uri) | |
volumes.uuid |
string (uuid) | |
volumes.name |
string | |
volumes.image_name |
string | Name of the image this volume was created from |
volumes.state |
string | |
volumes.bootable |
boolean | Indicates if this volume can be used to boot an instance |
volumes.size |
integer | Size in MiB |
volumes.device |
string | Name of volume as instance device e.g. /dev/vdb. |
volumes.resource_type |
string | |
volumes.type |
string (uri) | Type of the volume (e.g. SSD, HDD) |
volumes.type_name |
string | |
volumes.marketplace_resource_uuid |
string | |
security_groups |
array of objects | |
security_groups.url |
string (uri) | |
security_groups.name |
string | |
security_groups.rules |
array of objects | |
security_groups.rules.ethertype |
any | IP protocol version - either 'IPv4' or 'IPv6' |
security_groups.rules.direction |
any | Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing) |
security_groups.rules.protocol |
any | The network protocol (TCP, UDP, ICMP, or empty for any protocol) |
security_groups.rules.from_port |
integer | Starting port number in the range (1-65535) |
security_groups.rules.to_port |
integer | Ending port number in the range (1-65535) |
security_groups.rules.cidr |
string | CIDR notation for the source/destination network address range |
security_groups.rules.description |
string | |
security_groups.rules.remote_group_name |
string | |
security_groups.rules.remote_group_uuid |
string (uuid) | |
security_groups.rules.id |
integer | |
security_groups.description |
string | |
security_groups.state |
string | |
server_group |
object | |
server_group.url |
string (uri) | |
server_group.name |
string | |
server_group.policy |
any | Server group policy determining the rules for scheduling servers in this group |
server_group.state |
string | |
floating_ips |
array of objects | |
floating_ips.url |
string (uri) | |
floating_ips.uuid |
string (uuid) | |
floating_ips.address |
any | The public IPv4 address of the floating IP |
floating_ips.port_fixed_ips |
array of objects | |
floating_ips.port_fixed_ips.ip_address |
any | IP address to assign to the port |
floating_ips.port_fixed_ips.subnet_id |
string | ID of the subnet in which to assign the IP address |
floating_ips.port_mac_address |
string | MAC address of the port |
floating_ips.subnet |
string (uri) | |
floating_ips.subnet_uuid |
string (uuid) | |
floating_ips.subnet_name |
string | |
floating_ips.subnet_description |
string | |
floating_ips.subnet_cidr |
string | IPv4 network address in CIDR format (e.g. 192.168.0.0/24) |
ports |
array of objects | |
ports.url |
string (uri) | |
ports.fixed_ips |
array of objects | |
ports.fixed_ips.ip_address |
any | IP address to assign to the port |
ports.fixed_ips.subnet_id |
string | ID of the subnet in which to assign the IP address |
ports.mac_address |
string | MAC address of the port |
ports.subnet |
string (uri) | Subnet to which this port belongs |
ports.subnet_uuid |
string (uuid) | |
ports.subnet_name |
string | |
ports.subnet_description |
string | |
ports.subnet_cidr |
string | IPv4 network address in CIDR format (e.g. 192.168.0.0/24) |
ports.allowed_address_pairs |
array of objects | |
ports.allowed_address_pairs.mac_address |
string | |
ports.device_id |
string | ID of device (instance, router etc) to which this port is connected |
ports.device_owner |
string | Entity that uses this port (e.g. network:router_interface) |
ports.security_groups |
array of objects | |
ports.security_groups.url |
string (uri) | |
ports.security_groups.uuid |
string (uuid) | |
ports.security_groups.name |
string | |
ports.security_groups.description |
string | |
ports.security_groups.service_name |
string | |
ports.security_groups.service_settings |
string (uri) | |
ports.security_groups.service_settings_uuid |
string (uuid) | |
ports.security_groups.service_settings_state |
string | |
ports.security_groups.service_settings_error_message |
string | |
ports.security_groups.project |
string (uri) | |
ports.security_groups.project_name |
string | |
ports.security_groups.project_uuid |
string (uuid) | |
ports.security_groups.customer |
string (uri) | |
ports.security_groups.customer_uuid |
string (uuid) | |
ports.security_groups.customer_name |
string | |
ports.security_groups.customer_native_name |
string | |
ports.security_groups.customer_abbreviation |
string | |
ports.security_groups.error_message |
string | |
ports.security_groups.error_traceback |
string | |
ports.security_groups.resource_type |
string | |
ports.security_groups.state |
any | |
ports.security_groups.created |
string (date-time) | |
ports.security_groups.modified |
string (date-time) | |
ports.security_groups.backend_id |
string | |
ports.security_groups.access_url |
string | |
ports.security_groups.tenant |
string (uri) | |
ports.security_groups.tenant_name |
string | |
ports.security_groups.tenant_uuid |
string (uuid) | |
ports.security_groups.rules |
array of objects | |
ports.security_groups.rules.ethertype |
any | IP protocol version - either 'IPv4' or 'IPv6' |
ports.security_groups.rules.direction |
any | Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing) |
ports.security_groups.rules.protocol |
any | The network protocol (TCP, UDP, ICMP, or empty for any protocol) |
ports.security_groups.rules.from_port |
integer | Starting port number in the range (1-65535) |
ports.security_groups.rules.to_port |
integer | Ending port number in the range (1-65535) |
ports.security_groups.rules.cidr |
string | CIDR notation for the source/destination network address range |
ports.security_groups.rules.description |
string | |
ports.security_groups.rules.remote_group_name |
string | |
ports.security_groups.rules.remote_group_uuid |
string (uuid) | |
ports.security_groups.rules.id |
integer | |
ports.security_groups.rules.remote_group |
string (uri) | Remote security group that this rule references, if any |
ports.security_groups.marketplace_offering_uuid |
string | |
ports.security_groups.marketplace_offering_name |
string | |
ports.security_groups.marketplace_offering_plugin_options |
object (free-form) | |
ports.security_groups.marketplace_category_uuid |
string | |
ports.security_groups.marketplace_category_name |
string | |
ports.security_groups.marketplace_resource_uuid |
string | |
ports.security_groups.marketplace_plan_uuid |
string | |
ports.security_groups.marketplace_resource_state |
string | |
ports.security_groups.is_usage_based |
boolean | |
ports.security_groups.is_limit_based |
boolean | |
availability_zone |
string (uri) | Availability zone where this instance is located |
availability_zone_name |
string | Name of the availability zone where instance is located |
connect_directly_to_external_network |
boolean | If True, instance will be connected directly to external network |
runtime_state |
string | |
action |
string | |
action_details |
any | Details about ongoing or completed actions |
tenant_uuid |
string (uuid) | UUID of the OpenStack tenant |
hypervisor_hostname |
string | Name of the hypervisor hosting this instance |
tenant |
string (uri) | The OpenStack tenant to create the instance in |
external_address |
array of strings | |
rancher_cluster |
any | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Partially update instance
Update specific fields of a VM instance.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedOpenStackInstanceRequest - API Source:
openstack_instances_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
name |
string | |
description |
string |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | OpenStack provider settings |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | Instance ID in the OpenStack backend |
access_url |
string | |
start_time |
string (date-time) | |
cores |
integer | Number of cores in a VM |
ram |
integer | Memory size in MiB |
disk |
integer | Disk size in MiB |
min_ram |
integer | Minimum memory size in MiB |
min_disk |
integer | Minimum disk size in MiB |
user_data |
string | Additional data that will be added to instance on provisioning |
external_ips |
array of string (ipv4)s | |
internal_ips |
array of string (ipv4)s | |
latitude |
number (double) | |
longitude |
number (double) | |
key_name |
string | |
key_fingerprint |
string | |
image_name |
string | |
flavor_disk |
integer | Flavor disk size in MiB |
flavor_name |
string | Name of the flavor used by this instance |
volumes |
array of objects | List of volumes attached to the instance |
volumes.url |
string (uri) | |
volumes.uuid |
string (uuid) | |
volumes.name |
string | |
volumes.image_name |
string | Name of the image this volume was created from |
volumes.state |
string | |
volumes.bootable |
boolean | Indicates if this volume can be used to boot an instance |
volumes.size |
integer | Size in MiB |
volumes.device |
string | Name of volume as instance device e.g. /dev/vdb. |
volumes.resource_type |
string | |
volumes.type |
string (uri) | Type of the volume (e.g. SSD, HDD) |
volumes.type_name |
string | |
volumes.marketplace_resource_uuid |
string | |
security_groups |
array of objects | |
security_groups.url |
string (uri) | |
security_groups.name |
string | |
security_groups.rules |
array of objects | |
security_groups.rules.ethertype |
any | IP protocol version - either 'IPv4' or 'IPv6' |
security_groups.rules.direction |
any | Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing) |
security_groups.rules.protocol |
any | The network protocol (TCP, UDP, ICMP, or empty for any protocol) |
security_groups.rules.from_port |
integer | Starting port number in the range (1-65535) |
security_groups.rules.to_port |
integer | Ending port number in the range (1-65535) |
security_groups.rules.cidr |
string | CIDR notation for the source/destination network address range |
security_groups.rules.description |
string | |
security_groups.rules.remote_group_name |
string | |
security_groups.rules.remote_group_uuid |
string (uuid) | |
security_groups.rules.id |
integer | |
security_groups.description |
string | |
security_groups.state |
string | |
server_group |
object | |
server_group.url |
string (uri) | |
server_group.name |
string | |
server_group.policy |
any | Server group policy determining the rules for scheduling servers in this group |
server_group.state |
string | |
floating_ips |
array of objects | |
floating_ips.url |
string (uri) | |
floating_ips.uuid |
string (uuid) | |
floating_ips.address |
any | The public IPv4 address of the floating IP |
floating_ips.port_fixed_ips |
array of objects | |
floating_ips.port_fixed_ips.ip_address |
any | IP address to assign to the port |
floating_ips.port_fixed_ips.subnet_id |
string | ID of the subnet in which to assign the IP address |
floating_ips.port_mac_address |
string | MAC address of the port |
floating_ips.subnet |
string (uri) | |
floating_ips.subnet_uuid |
string (uuid) | |
floating_ips.subnet_name |
string | |
floating_ips.subnet_description |
string | |
floating_ips.subnet_cidr |
string | IPv4 network address in CIDR format (e.g. 192.168.0.0/24) |
ports |
array of objects | |
ports.url |
string (uri) | |
ports.fixed_ips |
array of objects | |
ports.fixed_ips.ip_address |
any | IP address to assign to the port |
ports.fixed_ips.subnet_id |
string | ID of the subnet in which to assign the IP address |
ports.mac_address |
string | MAC address of the port |
ports.subnet |
string (uri) | Subnet to which this port belongs |
ports.subnet_uuid |
string (uuid) | |
ports.subnet_name |
string | |
ports.subnet_description |
string | |
ports.subnet_cidr |
string | IPv4 network address in CIDR format (e.g. 192.168.0.0/24) |
ports.allowed_address_pairs |
array of objects | |
ports.allowed_address_pairs.mac_address |
string | |
ports.device_id |
string | ID of device (instance, router etc) to which this port is connected |
ports.device_owner |
string | Entity that uses this port (e.g. network:router_interface) |
ports.security_groups |
array of objects | |
ports.security_groups.url |
string (uri) | |
ports.security_groups.uuid |
string (uuid) | |
ports.security_groups.name |
string | |
ports.security_groups.description |
string | |
ports.security_groups.service_name |
string | |
ports.security_groups.service_settings |
string (uri) | |
ports.security_groups.service_settings_uuid |
string (uuid) | |
ports.security_groups.service_settings_state |
string | |
ports.security_groups.service_settings_error_message |
string | |
ports.security_groups.project |
string (uri) | |
ports.security_groups.project_name |
string | |
ports.security_groups.project_uuid |
string (uuid) | |
ports.security_groups.customer |
string (uri) | |
ports.security_groups.customer_uuid |
string (uuid) | |
ports.security_groups.customer_name |
string | |
ports.security_groups.customer_native_name |
string | |
ports.security_groups.customer_abbreviation |
string | |
ports.security_groups.error_message |
string | |
ports.security_groups.error_traceback |
string | |
ports.security_groups.resource_type |
string | |
ports.security_groups.state |
any | |
ports.security_groups.created |
string (date-time) | |
ports.security_groups.modified |
string (date-time) | |
ports.security_groups.backend_id |
string | |
ports.security_groups.access_url |
string | |
ports.security_groups.tenant |
string (uri) | |
ports.security_groups.tenant_name |
string | |
ports.security_groups.tenant_uuid |
string (uuid) | |
ports.security_groups.rules |
array of objects | |
ports.security_groups.rules.ethertype |
any | IP protocol version - either 'IPv4' or 'IPv6' |
ports.security_groups.rules.direction |
any | Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing) |
ports.security_groups.rules.protocol |
any | The network protocol (TCP, UDP, ICMP, or empty for any protocol) |
ports.security_groups.rules.from_port |
integer | Starting port number in the range (1-65535) |
ports.security_groups.rules.to_port |
integer | Ending port number in the range (1-65535) |
ports.security_groups.rules.cidr |
string | CIDR notation for the source/destination network address range |
ports.security_groups.rules.description |
string | |
ports.security_groups.rules.remote_group_name |
string | |
ports.security_groups.rules.remote_group_uuid |
string (uuid) | |
ports.security_groups.rules.id |
integer | |
ports.security_groups.rules.remote_group |
string (uri) | Remote security group that this rule references, if any |
ports.security_groups.marketplace_offering_uuid |
string | |
ports.security_groups.marketplace_offering_name |
string | |
ports.security_groups.marketplace_offering_plugin_options |
object (free-form) | |
ports.security_groups.marketplace_category_uuid |
string | |
ports.security_groups.marketplace_category_name |
string | |
ports.security_groups.marketplace_resource_uuid |
string | |
ports.security_groups.marketplace_plan_uuid |
string | |
ports.security_groups.marketplace_resource_state |
string | |
ports.security_groups.is_usage_based |
boolean | |
ports.security_groups.is_limit_based |
boolean | |
availability_zone |
string (uri) | Availability zone where this instance is located |
availability_zone_name |
string | Name of the availability zone where instance is located |
connect_directly_to_external_network |
boolean | If True, instance will be connected directly to external network |
runtime_state |
string | |
action |
string | |
action_details |
any | Details about ongoing or completed actions |
tenant_uuid |
string (uuid) | UUID of the OpenStack tenant |
hypervisor_hostname |
string | Name of the hypervisor hosting this instance |
tenant |
string (uri) | The OpenStack tenant to create the instance in |
external_address |
array of strings | |
rancher_cluster |
any | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
State Management
Restart instance
Restart the instance
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_instances_restart
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - No response body
Start instance
Start the instance
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_instances_start
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - No response body
Stop instance
Stop the instance
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_instances_stop
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - No response body
Subresource Management
Get console log
Get console log for the instance
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_instances_console_log_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type |
|---|---|
length |
integer |
200 -
Get console URL
Get console url for the instance
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_instances_console_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
List instance floating IPs
Get a list of instance floating IPs
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- API Source:
openstack_instances_floating_ips_list
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
address |
any | The public IPv4 address of the floating IP |
port_fixed_ips |
array of objects | |
port_fixed_ips.ip_address |
any | IP address to assign to the port |
port_fixed_ips.subnet_id |
string | ID of the subnet in which to assign the IP address |
port_mac_address |
string | MAC address of the port |
subnet |
string (uri) | |
subnet_uuid |
string (uuid) | |
subnet_name |
string | |
subnet_description |
string | |
subnet_cidr |
string | IPv4 network address in CIDR format (e.g. 192.168.0.0/24) |
List instance ports
Get a list of instance ports
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- API Source:
openstack_instances_ports_list
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
fixed_ips |
array of objects | |
fixed_ips.ip_address |
any | IP address to assign to the port |
fixed_ips.subnet_id |
string | ID of the subnet in which to assign the IP address |
mac_address |
string | MAC address of the port |
subnet |
string (uri) | Subnet to which this port belongs |
subnet_uuid |
string (uuid) | |
subnet_name |
string | |
subnet_description |
string | |
subnet_cidr |
string | IPv4 network address in CIDR format (e.g. 192.168.0.0/24) |
allowed_address_pairs |
array of objects | |
allowed_address_pairs.mac_address |
string | |
device_id |
string | ID of device (instance, router etc) to which this port is connected |
device_owner |
string | Entity that uses this port (e.g. network:router_interface) |
security_groups |
array of objects | |
security_groups.url |
string (uri) | |
security_groups.uuid |
string (uuid) | |
security_groups.name |
string | |
security_groups.description |
string | |
security_groups.service_name |
string | |
security_groups.service_settings |
string (uri) | |
security_groups.service_settings_uuid |
string (uuid) | |
security_groups.service_settings_state |
string | |
security_groups.service_settings_error_message |
string | |
security_groups.project |
string (uri) | |
security_groups.project_name |
string | |
security_groups.project_uuid |
string (uuid) | |
security_groups.customer |
string (uri) | |
security_groups.customer_uuid |
string (uuid) | |
security_groups.customer_name |
string | |
security_groups.customer_native_name |
string | |
security_groups.customer_abbreviation |
string | |
security_groups.error_message |
string | |
security_groups.error_traceback |
string | |
security_groups.resource_type |
string | |
security_groups.state |
any | |
security_groups.created |
string (date-time) | |
security_groups.modified |
string (date-time) | |
security_groups.backend_id |
string | |
security_groups.access_url |
string | |
security_groups.tenant |
string (uri) | |
security_groups.tenant_name |
string | |
security_groups.tenant_uuid |
string (uuid) | |
security_groups.rules |
array of objects | |
security_groups.rules.ethertype |
any | IP protocol version - either 'IPv4' or 'IPv6' |
security_groups.rules.direction |
any | Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing) |
security_groups.rules.protocol |
any | The network protocol (TCP, UDP, ICMP, or empty for any protocol) |
security_groups.rules.from_port |
integer | Starting port number in the range (1-65535) |
security_groups.rules.to_port |
integer | Ending port number in the range (1-65535) |
security_groups.rules.cidr |
string | CIDR notation for the source/destination network address range |
security_groups.rules.description |
string | |
security_groups.rules.remote_group_name |
string | |
security_groups.rules.remote_group_uuid |
string (uuid) | |
security_groups.rules.id |
integer | |
security_groups.rules.remote_group |
string (uri) | Remote security group that this rule references, if any |
security_groups.marketplace_offering_uuid |
string | |
security_groups.marketplace_offering_name |
string | |
security_groups.marketplace_offering_plugin_options |
object (free-form) | |
security_groups.marketplace_category_uuid |
string | |
security_groups.marketplace_category_name |
string | |
security_groups.marketplace_resource_uuid |
string | |
security_groups.marketplace_plan_uuid |
string | |
security_groups.marketplace_resource_state |
string | |
security_groups.is_usage_based |
boolean | |
security_groups.is_limit_based |
boolean |
Create instance backup
Create backup from instance
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
OpenStackBackupRequest - API Source:
openstack_instances_backup
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ✓ | |
description |
string | ||
kept_until |
string (date-time) | Guaranteed time of backup retention. If null - keep forever. |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
kept_until |
string (date-time) | Guaranteed time of backup retention. If null - keep forever. |
metadata |
any | |
instance |
string (uri) | Instance that this backup is created from |
instance_name |
string | |
instance_marketplace_uuid |
string (uuid) | |
restorations |
array of objects | |
restorations.uuid |
string (uuid) | |
restorations.instance |
string (uri) | Instance that is being restored from the backup |
restorations.created |
string (date-time) | |
restorations.flavor |
string (uri) | Flavor to be used for the restored instance. If not specified, original instance flavor will be used |
restorations.name |
string | New instance name. Leave blank to use source instance name. |
restorations.floating_ips |
array of objects | |
restorations.floating_ips.url |
string (uri) | |
restorations.floating_ips.uuid |
string (uuid) | |
restorations.floating_ips.address |
any | The public IPv4 address of the floating IP |
restorations.floating_ips.port_fixed_ips |
array of objects | |
restorations.floating_ips.port_fixed_ips.ip_address |
any | IP address to assign to the port |
restorations.floating_ips.port_fixed_ips.subnet_id |
string | ID of the subnet in which to assign the IP address |
restorations.floating_ips.port_mac_address |
string | MAC address of the port |
restorations.floating_ips.subnet |
string (uri) | |
restorations.floating_ips.subnet_uuid |
string (uuid) | |
restorations.floating_ips.subnet_name |
string | |
restorations.floating_ips.subnet_description |
string | |
restorations.floating_ips.subnet_cidr |
string | IPv4 network address in CIDR format (e.g. 192.168.0.0/24) |
restorations.security_groups |
array of objects | |
restorations.security_groups.url |
string (uri) | |
restorations.security_groups.name |
string | |
restorations.security_groups.rules |
array of objects | |
restorations.security_groups.rules.ethertype |
any | IP protocol version - either 'IPv4' or 'IPv6' |
restorations.security_groups.rules.direction |
any | Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing) |
restorations.security_groups.rules.protocol |
any | The network protocol (TCP, UDP, ICMP, or empty for any protocol) |
restorations.security_groups.rules.from_port |
integer | Starting port number in the range (1-65535) |
restorations.security_groups.rules.to_port |
integer | Ending port number in the range (1-65535) |
restorations.security_groups.rules.cidr |
string | CIDR notation for the source/destination network address range |
restorations.security_groups.rules.description |
string | |
restorations.security_groups.rules.remote_group_name |
string | |
restorations.security_groups.rules.remote_group_uuid |
string (uuid) | |
restorations.security_groups.rules.id |
integer | |
restorations.security_groups.description |
string | |
restorations.security_groups.state |
string | |
restorations.ports |
array of objects | |
restorations.ports.url |
string (uri) | |
restorations.ports.fixed_ips |
array of objects | |
restorations.ports.fixed_ips.ip_address |
any | IP address to assign to the port |
restorations.ports.fixed_ips.subnet_id |
string | ID of the subnet in which to assign the IP address |
restorations.ports.mac_address |
string | MAC address of the port |
restorations.ports.subnet |
string (uri) | Subnet to which this port belongs |
restorations.ports.subnet_uuid |
string (uuid) | |
restorations.ports.subnet_name |
string | |
restorations.ports.subnet_description |
string | |
restorations.ports.subnet_cidr |
string | IPv4 network address in CIDR format (e.g. 192.168.0.0/24) |
restorations.ports.allowed_address_pairs |
array of objects | |
restorations.ports.allowed_address_pairs.mac_address |
string | |
restorations.ports.device_id |
string | ID of device (instance, router etc) to which this port is connected |
restorations.ports.device_owner |
string | Entity that uses this port (e.g. network:router_interface) |
restorations.ports.security_groups |
array of objects | |
restorations.ports.security_groups.url |
string (uri) | |
restorations.ports.security_groups.uuid |
string (uuid) | |
restorations.ports.security_groups.name |
string | |
restorations.ports.security_groups.description |
string | |
restorations.ports.security_groups.service_name |
string | |
restorations.ports.security_groups.service_settings |
string (uri) | |
restorations.ports.security_groups.service_settings_uuid |
string (uuid) | |
restorations.ports.security_groups.service_settings_state |
string | |
restorations.ports.security_groups.service_settings_error_message |
string | |
restorations.ports.security_groups.project |
string (uri) | |
restorations.ports.security_groups.project_name |
string | |
restorations.ports.security_groups.project_uuid |
string (uuid) | |
restorations.ports.security_groups.customer |
string (uri) | |
restorations.ports.security_groups.customer_uuid |
string (uuid) | |
restorations.ports.security_groups.customer_name |
string | |
restorations.ports.security_groups.customer_native_name |
string | |
restorations.ports.security_groups.customer_abbreviation |
string | |
restorations.ports.security_groups.error_message |
string | |
restorations.ports.security_groups.error_traceback |
string | |
restorations.ports.security_groups.resource_type |
string | |
restorations.ports.security_groups.state |
any | |
restorations.ports.security_groups.created |
string (date-time) | |
restorations.ports.security_groups.modified |
string (date-time) | |
restorations.ports.security_groups.backend_id |
string | |
restorations.ports.security_groups.access_url |
string | |
restorations.ports.security_groups.tenant |
string (uri) | |
restorations.ports.security_groups.tenant_name |
string | |
restorations.ports.security_groups.tenant_uuid |
string (uuid) | |
restorations.ports.security_groups.rules |
array of objects | |
restorations.ports.security_groups.rules.ethertype |
any | IP protocol version - either 'IPv4' or 'IPv6' |
restorations.ports.security_groups.rules.direction |
any | Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing) |
restorations.ports.security_groups.rules.protocol |
any | The network protocol (TCP, UDP, ICMP, or empty for any protocol) |
restorations.ports.security_groups.rules.from_port |
integer | Starting port number in the range (1-65535) |
restorations.ports.security_groups.rules.to_port |
integer | Ending port number in the range (1-65535) |
restorations.ports.security_groups.rules.cidr |
string | CIDR notation for the source/destination network address range |
restorations.ports.security_groups.rules.description |
string | |
restorations.ports.security_groups.rules.remote_group_name |
string | |
restorations.ports.security_groups.rules.remote_group_uuid |
string (uuid) | |
restorations.ports.security_groups.rules.id |
integer | |
restorations.ports.security_groups.rules.remote_group |
string (uri) | Remote security group that this rule references, if any |
restorations.ports.security_groups.marketplace_offering_uuid |
string | |
restorations.ports.security_groups.marketplace_offering_name |
string | |
restorations.ports.security_groups.marketplace_offering_plugin_options |
object (free-form) | |
restorations.ports.security_groups.marketplace_category_uuid |
string | |
restorations.ports.security_groups.marketplace_category_name |
string | |
restorations.ports.security_groups.marketplace_resource_uuid |
string | |
restorations.ports.security_groups.marketplace_plan_uuid |
string | |
restorations.ports.security_groups.marketplace_resource_state |
string | |
restorations.ports.security_groups.is_usage_based |
boolean | |
restorations.ports.security_groups.is_limit_based |
boolean | |
instance_security_groups |
array of objects | |
instance_security_groups.url |
string (uri) | |
instance_security_groups.name |
string | |
instance_security_groups.rules |
array of objects | |
instance_security_groups.rules.ethertype |
any | IP protocol version - either 'IPv4' or 'IPv6' |
instance_security_groups.rules.direction |
any | Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing) |
instance_security_groups.rules.protocol |
any | The network protocol (TCP, UDP, ICMP, or empty for any protocol) |
instance_security_groups.rules.from_port |
integer | Starting port number in the range (1-65535) |
instance_security_groups.rules.to_port |
integer | Ending port number in the range (1-65535) |
instance_security_groups.rules.cidr |
string | CIDR notation for the source/destination network address range |
instance_security_groups.rules.description |
string | |
instance_security_groups.rules.remote_group_name |
string | |
instance_security_groups.rules.remote_group_uuid |
string (uuid) | |
instance_security_groups.rules.id |
integer | |
instance_security_groups.description |
string | |
instance_security_groups.state |
string | |
instance_ports |
array of objects | |
instance_ports.url |
string (uri) | |
instance_ports.fixed_ips |
array of objects | |
instance_ports.fixed_ips.ip_address |
any | IP address to assign to the port |
instance_ports.fixed_ips.subnet_id |
string | ID of the subnet in which to assign the IP address |
instance_ports.mac_address |
string | MAC address of the port |
instance_ports.subnet |
string (uri) | Subnet to which this port belongs |
instance_ports.subnet_uuid |
string (uuid) | |
instance_ports.subnet_name |
string | |
instance_ports.subnet_description |
string | |
instance_ports.subnet_cidr |
string | IPv4 network address in CIDR format (e.g. 192.168.0.0/24) |
instance_ports.allowed_address_pairs |
array of objects | |
instance_ports.allowed_address_pairs.mac_address |
string | |
instance_ports.device_id |
string | ID of device (instance, router etc) to which this port is connected |
instance_ports.device_owner |
string | Entity that uses this port (e.g. network:router_interface) |
instance_ports.security_groups |
array of objects | |
instance_ports.security_groups.url |
string (uri) | |
instance_ports.security_groups.uuid |
string (uuid) | |
instance_ports.security_groups.name |
string | |
instance_ports.security_groups.description |
string | |
instance_ports.security_groups.service_name |
string | |
instance_ports.security_groups.service_settings |
string (uri) | |
instance_ports.security_groups.service_settings_uuid |
string (uuid) | |
instance_ports.security_groups.service_settings_state |
string | |
instance_ports.security_groups.service_settings_error_message |
string | |
instance_ports.security_groups.project |
string (uri) | |
instance_ports.security_groups.project_name |
string | |
instance_ports.security_groups.project_uuid |
string (uuid) | |
instance_ports.security_groups.customer |
string (uri) | |
instance_ports.security_groups.customer_uuid |
string (uuid) | |
instance_ports.security_groups.customer_name |
string | |
instance_ports.security_groups.customer_native_name |
string | |
instance_ports.security_groups.customer_abbreviation |
string | |
instance_ports.security_groups.error_message |
string | |
instance_ports.security_groups.error_traceback |
string | |
instance_ports.security_groups.resource_type |
string | |
instance_ports.security_groups.state |
any | |
instance_ports.security_groups.created |
string (date-time) | |
instance_ports.security_groups.modified |
string (date-time) | |
instance_ports.security_groups.backend_id |
string | |
instance_ports.security_groups.access_url |
string | |
instance_ports.security_groups.tenant |
string (uri) | |
instance_ports.security_groups.tenant_name |
string | |
instance_ports.security_groups.tenant_uuid |
string (uuid) | |
instance_ports.security_groups.rules |
array of objects | |
instance_ports.security_groups.rules.ethertype |
any | IP protocol version - either 'IPv4' or 'IPv6' |
instance_ports.security_groups.rules.direction |
any | Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing) |
instance_ports.security_groups.rules.protocol |
any | The network protocol (TCP, UDP, ICMP, or empty for any protocol) |
instance_ports.security_groups.rules.from_port |
integer | Starting port number in the range (1-65535) |
instance_ports.security_groups.rules.to_port |
integer | Ending port number in the range (1-65535) |
instance_ports.security_groups.rules.cidr |
string | CIDR notation for the source/destination network address range |
instance_ports.security_groups.rules.description |
string | |
instance_ports.security_groups.rules.remote_group_name |
string | |
instance_ports.security_groups.rules.remote_group_uuid |
string (uuid) | |
instance_ports.security_groups.rules.id |
integer | |
instance_ports.security_groups.rules.remote_group |
string (uri) | Remote security group that this rule references, if any |
instance_ports.security_groups.marketplace_offering_uuid |
string | |
instance_ports.security_groups.marketplace_offering_name |
string | |
instance_ports.security_groups.marketplace_offering_plugin_options |
object (free-form) | |
instance_ports.security_groups.marketplace_category_uuid |
string | |
instance_ports.security_groups.marketplace_category_name |
string | |
instance_ports.security_groups.marketplace_resource_uuid |
string | |
instance_ports.security_groups.marketplace_plan_uuid |
string | |
instance_ports.security_groups.marketplace_resource_state |
string | |
instance_ports.security_groups.is_usage_based |
boolean | |
instance_ports.security_groups.is_limit_based |
boolean | |
instance_floating_ips |
array of objects | |
instance_floating_ips.url |
string (uri) | |
instance_floating_ips.uuid |
string (uuid) | |
instance_floating_ips.address |
any | The public IPv4 address of the floating IP |
instance_floating_ips.port_fixed_ips |
array of objects | |
instance_floating_ips.port_fixed_ips.ip_address |
any | IP address to assign to the port |
instance_floating_ips.port_fixed_ips.subnet_id |
string | ID of the subnet in which to assign the IP address |
instance_floating_ips.port_mac_address |
string | MAC address of the port |
instance_floating_ips.subnet |
string (uri) | |
instance_floating_ips.subnet_uuid |
string (uuid) | |
instance_floating_ips.subnet_name |
string | |
instance_floating_ips.subnet_description |
string | |
instance_floating_ips.subnet_cidr |
string | IPv4 network address in CIDR format (e.g. 192.168.0.0/24) |
tenant_uuid |
string (uuid) | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Update instance allowed address pairs
Update allowed address pairs of the instance
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
OpenStackInstanceAllowedAddressPairsUpdateRequest - API Source:
openstack_instances_update_allowed_address_pairs
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
subnet |
string (uri) | ✓ | The subnet to update allowed address pairs for. Constraints: write-only |
allowed_address_pairs |
array of objects | ✓ | List of allowed address pairs to set on the port. Each pair should contain 'ip_address' and optional 'mac_address'. |
allowed_address_pairs.ip_address |
string | Constraints: write-only, default: 192.168.42.0/24 |
|
allowed_address_pairs.mac_address |
string |
200 - No response body
Update instance floating IPs
Update floating IPs of the instance
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
OpenStackInstanceFloatingIPsUpdateRequest - API Source:
openstack_instances_update_floating_ips
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
floating_ips |
array of objects | ||
floating_ips.url |
string (uri) | ||
floating_ips.ip_address |
any | Existing floating IP address in selected OpenStack tenant to be assigned to new virtual machine | |
floating_ips.subnet |
string (uri) | ✓ |
200 - No response body
Update instance ports
Update ports of the instance
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | |
- Model Source:
OpenStackInstancePortsUpdateRequest - API Source:
openstack_instances_update_ports
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
ports |
array of objects | ✓ | |
ports.fixed_ips |
array of objects | ||
ports.fixed_ips.ip_address |
any | ✓ | IP address to assign to the port |
ports.fixed_ips.subnet_id |
string | ✓ | ID of the subnet in which to assign the IP address |
ports.subnet |
string (uri) | Subnet to which this port belongs | |
ports.port |
string (uri) | ||
ports.tenant |
string (uri) | Target tenant for port creation. If not specified, uses subnet's tenant. Constraints: write-only |
200 - No response body
Update instance security groups
Update security groups of the instance
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | |
- Model Source:
OpenStackInstanceSecurityGroupsUpdateRequest - API Source:
openstack_instances_update_security_groups
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
security_groups |
array of string (uri)s | ✓ | List of security groups to be assigned to the instance. |
200 - No response body
Other Actions
Change instance flavor
Change flavor of the instance
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
InstanceFlavorChangeRequest - API Source:
openstack_instances_change_flavor
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
flavor |
string (uri) | ✓ | The new flavor to use for the instance. Flavor change can only be done when instance is stopped. |
200 - No response body
Mark resource as ERRED
Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
SetErredRequest - API Source:
openstack_instances_set_erred
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
error_message |
string | |
error_traceback |
string |
200 -
| Field | Type |
|---|---|
detail |
string |
Mark resource as OK
Manually transition the resource to OK state and clear error fields. Staff-only operation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_instances_set_ok
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
detail |
string |
Openstack Marketplace Tenants
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/openstack-marketplace-tenants/ |
List Openstack Marketplace Tenants |
| GET | /api/openstack-marketplace-tenants/{uuid}/ |
Retrieve |
| POST | /api/openstack-marketplace-tenants/{uuid}/create_image/ |
Create image |
| Other Actions | ||
| POST | /api/openstack-marketplace-tenants/{uuid}/upload_image_data/{image_id}/ |
Data |
Core CRUD
List Openstack Marketplace Tenants
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 | |
- Model Source:
CoreStates - API Source:
openstack_marketplace_tenants_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
backend_id |
string | Backend ID |
can_manage |
boolean | Can manage |
customer |
string (uuid) | Customer UUID |
customer_abbreviation |
string | Customer abbreviation |
customer_name |
string | Customer name |
customer_native_name |
string | Customer native name |
customer_uuid |
string (uuid) | Customer UUID |
description |
string | Description |
external_ip |
string | External IP |
name |
string | Name |
name_exact |
string | Name (exact) |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
project |
string (uuid) | Project UUID |
project_name |
string | Project name |
project_uuid |
string (uuid) | Project UUID |
service_settings_name |
string | Service settings name |
service_settings_uuid |
string (uuid) | Service settings UUID |
state |
array | State |
uuid |
string (uuid) | UUID |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_marketplace_tenants_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
Create image
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
ImageCreateRequest - API Source:
openstack_marketplace_tenants_create_image
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
name |
string | ✓ |
min_ram |
integer | |
min_disk |
integer | |
disk_format |
any | |
container_format |
any | |
visibility |
any |
201 -
| Field | Type |
|---|---|
image_id |
string (uuid) |
name |
string |
status |
string |
upload_url |
string |
Other Actions
Data
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- API Source:
openstack_marketplace_tenants_upload_image_data
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Name | Type | Required |
|---|---|---|
image_id |
string (uuid) | ✓ |
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
status |
string |
message |
string |
Openstack Migrations
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/openstack-migrations/ |
List Openstack Migrations |
| GET | /api/openstack-migrations/{uuid}/ |
Retrieve |
| POST | /api/openstack-migrations/ |
Create |
| PUT | /api/openstack-migrations/{uuid}/ |
Update |
| PATCH | /api/openstack-migrations/{uuid}/ |
Partial Update |
| DELETE | /api/openstack-migrations/{uuid}/ |
Delete |
List Openstack Migrations
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
openstack_migrations_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
dst_resource_uuid |
string (uuid) | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
src_resource_uuid |
string (uuid) |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
uuid |
string (uuid) |
created |
string (date-time) |
modified |
string (date-time) |
mappings |
object |
mappings.volume_types |
array of objects |
mappings.volume_types.src_type_uuid |
string (uuid) |
mappings.volume_types.dst_type_uuid |
string (uuid) |
mappings.subnets |
array of objects |
mappings.subnets.src_cidr |
string |
mappings.subnets.dst_cidr |
string |
mappings.skip_connection_extnet |
boolean |
mappings.sync_instance_ports |
boolean |
mappings.networks |
array of string (uuid)s |
created_by_uuid |
string (uuid) |
created_by_full_name |
string |
src_offering_uuid |
string (uuid) |
src_offering_name |
string |
dst_offering_uuid |
string (uuid) |
dst_offering_name |
string |
src_resource_uuid |
string (uuid) |
src_resource_name |
string |
dst_resource_uuid |
string (uuid) |
dst_resource_name |
string |
dst_resource_state |
string |
state |
string |
error_message |
string |
error_traceback |
string |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_migrations_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
created |
string (date-time) |
modified |
string (date-time) |
mappings |
object |
mappings.volume_types |
array of objects |
mappings.volume_types.src_type_uuid |
string (uuid) |
mappings.volume_types.dst_type_uuid |
string (uuid) |
mappings.subnets |
array of objects |
mappings.subnets.src_cidr |
string |
mappings.subnets.dst_cidr |
string |
mappings.skip_connection_extnet |
boolean |
mappings.sync_instance_ports |
boolean |
mappings.networks |
array of string (uuid)s |
created_by_uuid |
string (uuid) |
created_by_full_name |
string |
src_offering_uuid |
string (uuid) |
src_offering_name |
string |
dst_offering_uuid |
string (uuid) |
dst_offering_name |
string |
src_resource_uuid |
string (uuid) |
src_resource_name |
string |
dst_resource_uuid |
string (uuid) |
dst_resource_name |
string |
dst_resource_state |
string |
state |
string |
error_message |
string |
error_traceback |
string |
Create
1 2 3 4 5 6 7 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
MigrationCreateRequest - API Source:
openstack_migrations_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
| Field | Type | Required |
|---|---|---|
name |
string | |
description |
string | |
mappings |
object | |
mappings.volume_types |
array of objects | |
mappings.volume_types.src_type_uuid |
string (uuid) | ✓ |
mappings.volume_types.dst_type_uuid |
string (uuid) | ✓ |
mappings.subnets |
array of objects | |
mappings.subnets.src_cidr |
string | ✓ |
mappings.subnets.dst_cidr |
string | ✓ |
mappings.skip_connection_extnet |
boolean | |
mappings.sync_instance_ports |
boolean | |
mappings.networks |
array of string (uuid)s | |
src_resource |
string (uuid) | ✓ |
dst_offering |
string (uuid) | ✓ |
dst_plan |
string (uuid) | ✓ |
201 -
| Field | Type |
|---|---|
mappings |
object |
mappings.volume_types |
array of objects |
mappings.volume_types.src_type_uuid |
string (uuid) |
mappings.volume_types.dst_type_uuid |
string (uuid) |
mappings.subnets |
array of objects |
mappings.subnets.src_cidr |
string |
mappings.subnets.dst_cidr |
string |
mappings.skip_connection_extnet |
boolean |
mappings.sync_instance_ports |
boolean |
mappings.networks |
array of string (uuid)s |
src_resource |
string (uuid) |
Update
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
MigrationDetailsRequest - API Source:
openstack_migrations_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
mappings |
object | ✓ |
mappings.volume_types |
array of objects | |
mappings.volume_types.src_type_uuid |
string (uuid) | ✓ |
mappings.volume_types.dst_type_uuid |
string (uuid) | ✓ |
mappings.subnets |
array of objects | |
mappings.subnets.src_cidr |
string | ✓ |
mappings.subnets.dst_cidr |
string | ✓ |
mappings.skip_connection_extnet |
boolean | |
mappings.sync_instance_ports |
boolean | |
mappings.networks |
array of string (uuid)s | |
error_message |
string | |
error_traceback |
string |
200 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
created |
string (date-time) |
modified |
string (date-time) |
mappings |
object |
mappings.volume_types |
array of objects |
mappings.volume_types.src_type_uuid |
string (uuid) |
mappings.volume_types.dst_type_uuid |
string (uuid) |
mappings.subnets |
array of objects |
mappings.subnets.src_cidr |
string |
mappings.subnets.dst_cidr |
string |
mappings.skip_connection_extnet |
boolean |
mappings.sync_instance_ports |
boolean |
mappings.networks |
array of string (uuid)s |
created_by_uuid |
string (uuid) |
created_by_full_name |
string |
src_offering_uuid |
string (uuid) |
src_offering_name |
string |
dst_offering_uuid |
string (uuid) |
dst_offering_name |
string |
src_resource_uuid |
string (uuid) |
src_resource_name |
string |
dst_resource_uuid |
string (uuid) |
dst_resource_name |
string |
dst_resource_state |
string |
state |
string |
error_message |
string |
error_traceback |
string |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedMigrationDetailsRequest - API Source:
openstack_migrations_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
mappings |
object | |
mappings.volume_types |
array of objects | |
mappings.volume_types.src_type_uuid |
string (uuid) | ✓ |
mappings.volume_types.dst_type_uuid |
string (uuid) | ✓ |
mappings.subnets |
array of objects | |
mappings.subnets.src_cidr |
string | ✓ |
mappings.subnets.dst_cidr |
string | ✓ |
mappings.skip_connection_extnet |
boolean | |
mappings.sync_instance_ports |
boolean | |
mappings.networks |
array of string (uuid)s | |
error_message |
string | |
error_traceback |
string |
200 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
created |
string (date-time) |
modified |
string (date-time) |
mappings |
object |
mappings.volume_types |
array of objects |
mappings.volume_types.src_type_uuid |
string (uuid) |
mappings.volume_types.dst_type_uuid |
string (uuid) |
mappings.subnets |
array of objects |
mappings.subnets.src_cidr |
string |
mappings.subnets.dst_cidr |
string |
mappings.skip_connection_extnet |
boolean |
mappings.sync_instance_ports |
boolean |
mappings.networks |
array of string (uuid)s |
created_by_uuid |
string (uuid) |
created_by_full_name |
string |
src_offering_uuid |
string (uuid) |
src_offering_name |
string |
dst_offering_uuid |
string (uuid) |
dst_offering_name |
string |
src_resource_uuid |
string (uuid) |
src_resource_name |
string |
dst_resource_uuid |
string (uuid) |
dst_resource_name |
string |
dst_resource_state |
string |
state |
string |
error_message |
string |
error_traceback |
string |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_migrations_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Openstack Network Rbac Policies
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/openstack-network-rbac-policies/ |
List network RBAC policies |
| GET | /api/openstack-network-rbac-policies/{uuid}/ |
Get network RBAC policy details |
| POST | /api/openstack-network-rbac-policies/ |
Create RBAC policy |
| PUT | /api/openstack-network-rbac-policies/{uuid}/ |
Update |
| PATCH | /api/openstack-network-rbac-policies/{uuid}/ |
Partial Update |
| DELETE | /api/openstack-network-rbac-policies/{uuid}/ |
Delete RBAC policy |
List network RBAC policies
Get a list of network RBAC policies.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 | |
- Model Source:
PolicyTypeEnum - API Source:
openstack_network_rbac_policies_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
network |
string (uri) | Network URL |
network_uuid |
string (uuid) | Network UUID |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
policy_type |
string | Type of access granted - either shared access or external network access Enum: access_as_shared, access_as_external |
target_tenant |
string (uri) | Target tenant URL |
target_tenant_uuid |
string (uuid) | Target tenant UUID |
tenant |
string (uri) | Tenant URL |
tenant_uuid |
string (uuid) | Tenant UUID |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
network |
string (uri) | |
network_name |
string | |
target_tenant |
string (uri) | |
target_tenant_name |
string | |
backend_id |
string | |
policy_type |
any | Type of access granted - either shared access or external network access |
created |
string (date-time) |
Get network RBAC policy details
Retrieve details of a specific network RBAC policy.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_network_rbac_policies_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
network |
string (uri) | |
network_name |
string | |
target_tenant |
string (uri) | |
target_tenant_name |
string | |
backend_id |
string | |
policy_type |
any | Type of access granted - either shared access or external network access |
created |
string (date-time) |
Create RBAC policy
Create RBAC policy for the network
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
NetworkRBACPolicyRequest - API Source:
openstack_network_rbac_policies_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Field | Type | Required | Description |
|---|---|---|---|
network |
string (uri) | ✓ | |
target_tenant |
string (uri) | ✓ | |
policy_type |
any | Type of access granted - either shared access or external network access Constraints: default: access_as_shared |
201 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
network |
string (uri) | |
network_name |
string | |
target_tenant |
string (uri) | |
target_tenant_name |
string | |
backend_id |
string | |
policy_type |
any | Type of access granted - either shared access or external network access |
created |
string (date-time) |
Update
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
NetworkRBACPolicyRequest - API Source:
openstack_network_rbac_policies_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
network |
string (uri) | ✓ | |
target_tenant |
string (uri) | ✓ | |
policy_type |
any | Type of access granted - either shared access or external network access Constraints: default: access_as_shared |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
network |
string (uri) | |
network_name |
string | |
target_tenant |
string (uri) | |
target_tenant_name |
string | |
backend_id |
string | |
policy_type |
any | Type of access granted - either shared access or external network access |
created |
string (date-time) |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedNetworkRBACPolicyRequest - API Source:
openstack_network_rbac_policies_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
network |
string (uri) | ||
target_tenant |
string (uri) | ||
policy_type |
any | Type of access granted - either shared access or external network access Constraints: default: access_as_shared |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
network |
string (uri) | |
network_name |
string | |
target_tenant |
string (uri) | |
target_tenant_name |
string | |
backend_id |
string | |
policy_type |
any | Type of access granted - either shared access or external network access |
created |
string (date-time) |
Delete RBAC policy
Delete RBAC policy for the network
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_network_rbac_policies_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Openstack Networks
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/openstack-networks/ |
List networks |
| GET | /api/openstack-networks/{uuid}/ |
Get network details |
| POST | /api/openstack-networks/{uuid}/create_subnet/ |
Create subnet |
| POST | /api/openstack-networks/{uuid}/pull/ |
Synchronize resource state |
| POST | /api/openstack-networks/{uuid}/unlink/ |
Unlink resource |
| PUT | /api/openstack-networks/{uuid}/ |
Update network |
| PATCH | /api/openstack-networks/{uuid}/ |
Partially update network |
| DELETE | /api/openstack-networks/{uuid}/ |
Delete network |
| Other Actions | ||
| POST | /api/openstack-networks/{uuid}/rbac_policy_create/ |
Create RBAC policy |
| POST | /api/openstack-networks/{uuid}/set_erred/ |
Mark resource as ERRED |
| POST | /api/openstack-networks/{uuid}/set_mtu/ |
Set network MTU |
| POST | /api/openstack-networks/{uuid}/set_ok/ |
Mark resource as OK |
| DELETE | /api/openstack-networks/{uuid}/rbac_policy_delete/{rbac_policy_uuid}/ |
Delete RBAC policy |
Core CRUD
List networks
Get a list of networks.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- Model Source:
CoreStates - Model Source:
OpenStackNetworkFieldEnum - API Source:
openstack_networks_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
backend_id |
string | Backend ID |
can_manage |
boolean | Can manage |
customer |
string (uuid) | Customer UUID |
customer_abbreviation |
string | Customer abbreviation |
customer_name |
string | Customer name |
customer_native_name |
string | Customer native name |
customer_uuid |
string (uuid) | Customer UUID |
description |
string | Description |
direct_only |
boolean | Direct only |
external_ip |
string | External IP |
field |
array | |
is_external |
boolean | |
name |
string | Name |
name_exact |
string | Name (exact) |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
project |
string (uuid) | Project UUID |
project_name |
string | Project name |
project_uuid |
string (uuid) | Project UUID |
rbac_only |
boolean | RBAC only |
service_settings_name |
string | Service settings name |
service_settings_uuid |
string (uuid) | Service settings UUID |
state |
array | State |
tenant |
string (uri) | Tenant URL |
tenant_uuid |
string (uuid) | Tenant UUID |
type |
string | |
uuid |
string (uuid) | UUID |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
tenant |
string (uri) | OpenStack tenant this network belongs to |
tenant_name |
string | |
tenant_uuid |
string (uuid) | |
is_external |
boolean | Defines whether this network is external (public) or internal (private) |
type |
string | Network type, such as local, flat, vlan, vxlan, or gre |
segmentation_id |
integer | VLAN ID for VLAN networks or tunnel ID for VXLAN/GRE networks |
subnets |
array of objects | |
subnets.uuid |
string (uuid) | |
subnets.name |
string | |
subnets.description |
string | |
subnets.cidr |
string | IPv4 network address in CIDR format (e.g. 192.168.0.0/24) |
subnets.gateway_ip |
any | IP address of the gateway for this subnet |
subnets.allocation_pools |
array of objects | |
subnets.allocation_pools.start |
any | An IPv4 or IPv6 address. |
subnets.allocation_pools.end |
any | An IPv4 or IPv6 address. |
subnets.ip_version |
integer | IP protocol version (4 or 6) |
subnets.enable_dhcp |
boolean | If True, DHCP service will be enabled on this subnet |
mtu |
integer | The maximum transmission unit (MTU) value to address fragmentation. |
rbac_policies |
array of objects | |
rbac_policies.url |
string (uri) | |
rbac_policies.uuid |
string (uuid) | |
rbac_policies.network |
string (uri) | |
rbac_policies.network_name |
string | |
rbac_policies.target_tenant |
string (uri) | |
rbac_policies.target_tenant_name |
string | |
rbac_policies.backend_id |
string | |
rbac_policies.policy_type |
any | Type of access granted - either shared access or external network access |
rbac_policies.created |
string (date-time) | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Get network details
Retrieve details of a specific network.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
OpenStackNetworkFieldEnum - API Source:
openstack_networks_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
tenant |
string (uri) | OpenStack tenant this network belongs to |
tenant_name |
string | |
tenant_uuid |
string (uuid) | |
is_external |
boolean | Defines whether this network is external (public) or internal (private) |
type |
string | Network type, such as local, flat, vlan, vxlan, or gre |
segmentation_id |
integer | VLAN ID for VLAN networks or tunnel ID for VXLAN/GRE networks |
subnets |
array of objects | |
subnets.uuid |
string (uuid) | |
subnets.name |
string | |
subnets.description |
string | |
subnets.cidr |
string | IPv4 network address in CIDR format (e.g. 192.168.0.0/24) |
subnets.gateway_ip |
any | IP address of the gateway for this subnet |
subnets.allocation_pools |
array of objects | |
subnets.allocation_pools.start |
any | An IPv4 or IPv6 address. |
subnets.allocation_pools.end |
any | An IPv4 or IPv6 address. |
subnets.ip_version |
integer | IP protocol version (4 or 6) |
subnets.enable_dhcp |
boolean | If True, DHCP service will be enabled on this subnet |
mtu |
integer | The maximum transmission unit (MTU) value to address fragmentation. |
rbac_policies |
array of objects | |
rbac_policies.url |
string (uri) | |
rbac_policies.uuid |
string (uuid) | |
rbac_policies.network |
string (uri) | |
rbac_policies.network_name |
string | |
rbac_policies.target_tenant |
string (uri) | |
rbac_policies.target_tenant_name |
string | |
rbac_policies.backend_id |
string | |
rbac_policies.policy_type |
any | Type of access granted - either shared access or external network access |
rbac_policies.created |
string (date-time) | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Create subnet
Create a new subnet within the network.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
OpenStackSubNetRequest - API Source:
openstack_networks_create_subnet
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ✓ | |
description |
string | ||
cidr |
string | ||
gateway_ip |
any | IP address of the gateway for this subnet | |
disable_gateway |
boolean | If True, no gateway IP address will be allocated | |
allocation_pools |
array of objects | ||
allocation_pools.start |
any | ✓ | An IPv4 or IPv6 address. |
allocation_pools.end |
any | ✓ | An IPv4 or IPv6 address. |
dns_nameservers |
array of anys | ||
host_routes |
array of objects | ||
host_routes.destination |
string | ✓ | |
host_routes.nexthop |
any | ✓ | An IPv4 or IPv6 address. |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
tenant |
string (uri) | |
tenant_name |
string | |
network |
string (uri) | Network to which this subnet belongs |
network_name |
string | |
cidr |
string | |
gateway_ip |
any | IP address of the gateway for this subnet |
disable_gateway |
boolean | If True, no gateway IP address will be allocated |
allocation_pools |
array of objects | |
allocation_pools.start |
any | An IPv4 or IPv6 address. |
allocation_pools.end |
any | An IPv4 or IPv6 address. |
ip_version |
integer | IP protocol version (4 or 6) |
enable_dhcp |
boolean | If True, DHCP service will be enabled on this subnet |
dns_nameservers |
array of anys | |
host_routes |
array of objects | |
host_routes.destination |
string | |
host_routes.nexthop |
any | An IPv4 or IPv6 address. |
is_connected |
boolean | Is subnet connected to the default tenant router. |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Synchronize resource state
Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_networks_pull
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
202 -
| Field | Type |
|---|---|
detail |
string |
409 -
| Field | Type |
|---|---|
detail |
string |
Unlink resource
Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_networks_unlink
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Update network
Update an existing network.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
OpenStackNetworkRequest - API Source:
openstack_networks_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
name |
string | ✓ |
description |
string |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
tenant |
string (uri) | OpenStack tenant this network belongs to |
tenant_name |
string | |
tenant_uuid |
string (uuid) | |
is_external |
boolean | Defines whether this network is external (public) or internal (private) |
type |
string | Network type, such as local, flat, vlan, vxlan, or gre |
segmentation_id |
integer | VLAN ID for VLAN networks or tunnel ID for VXLAN/GRE networks |
subnets |
array of objects | |
subnets.uuid |
string (uuid) | |
subnets.name |
string | |
subnets.description |
string | |
subnets.cidr |
string | IPv4 network address in CIDR format (e.g. 192.168.0.0/24) |
subnets.gateway_ip |
any | IP address of the gateway for this subnet |
subnets.allocation_pools |
array of objects | |
subnets.allocation_pools.start |
any | An IPv4 or IPv6 address. |
subnets.allocation_pools.end |
any | An IPv4 or IPv6 address. |
subnets.ip_version |
integer | IP protocol version (4 or 6) |
subnets.enable_dhcp |
boolean | If True, DHCP service will be enabled on this subnet |
mtu |
integer | The maximum transmission unit (MTU) value to address fragmentation. |
rbac_policies |
array of objects | |
rbac_policies.url |
string (uri) | |
rbac_policies.uuid |
string (uuid) | |
rbac_policies.network |
string (uri) | |
rbac_policies.network_name |
string | |
rbac_policies.target_tenant |
string (uri) | |
rbac_policies.target_tenant_name |
string | |
rbac_policies.backend_id |
string | |
rbac_policies.policy_type |
any | Type of access granted - either shared access or external network access |
rbac_policies.created |
string (date-time) | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Partially update network
Update specific fields of a network.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedOpenStackNetworkRequest - API Source:
openstack_networks_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
name |
string | |
description |
string |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
tenant |
string (uri) | OpenStack tenant this network belongs to |
tenant_name |
string | |
tenant_uuid |
string (uuid) | |
is_external |
boolean | Defines whether this network is external (public) or internal (private) |
type |
string | Network type, such as local, flat, vlan, vxlan, or gre |
segmentation_id |
integer | VLAN ID for VLAN networks or tunnel ID for VXLAN/GRE networks |
subnets |
array of objects | |
subnets.uuid |
string (uuid) | |
subnets.name |
string | |
subnets.description |
string | |
subnets.cidr |
string | IPv4 network address in CIDR format (e.g. 192.168.0.0/24) |
subnets.gateway_ip |
any | IP address of the gateway for this subnet |
subnets.allocation_pools |
array of objects | |
subnets.allocation_pools.start |
any | An IPv4 or IPv6 address. |
subnets.allocation_pools.end |
any | An IPv4 or IPv6 address. |
subnets.ip_version |
integer | IP protocol version (4 or 6) |
subnets.enable_dhcp |
boolean | If True, DHCP service will be enabled on this subnet |
mtu |
integer | The maximum transmission unit (MTU) value to address fragmentation. |
rbac_policies |
array of objects | |
rbac_policies.url |
string (uri) | |
rbac_policies.uuid |
string (uuid) | |
rbac_policies.network |
string (uri) | |
rbac_policies.network_name |
string | |
rbac_policies.target_tenant |
string (uri) | |
rbac_policies.target_tenant_name |
string | |
rbac_policies.backend_id |
string | |
rbac_policies.policy_type |
any | Type of access granted - either shared access or external network access |
rbac_policies.created |
string (date-time) | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Delete network
Delete a network.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_networks_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
Create RBAC policy
Create RBAC policy for the network. DEPRECATED: please use the dedicated /api/openstack-network-rbac-policies/ endpoint.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
DeprecatedNetworkRBACPolicyRequest - API Source:
openstack_networks_rbac_policy_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
target_tenant |
string (uri) | ✓ | |
policy_type |
any | Type of access granted - either shared access or external network access Constraints: default: access_as_shared |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
network |
string (uri) | |
network_name |
string | |
target_tenant |
string (uri) | |
target_tenant_name |
string | |
backend_id |
string | |
policy_type |
any | Type of access granted - either shared access or external network access |
created |
string (date-time) |
Mark resource as ERRED
Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
SetErredRequest - API Source:
openstack_networks_set_erred
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
error_message |
string | |
error_traceback |
string |
200 -
| Field | Type |
|---|---|
detail |
string |
Set network MTU
Update the Maximum Transmission Unit (MTU) for the network.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
SetMtuRequest - API Source:
openstack_networks_set_mtu
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
mtu |
integer | ✓ |
200 -
| Field | Type |
|---|---|
mtu |
integer |
Mark resource as OK
Manually transition the resource to OK state and clear error fields. Staff-only operation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_networks_set_ok
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
detail |
string |
Delete RBAC policy
Delete RBAC policy for the network. DEPRECATED: please use the dedicated /api/openstack-network-rbac-policies/ endpoint.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- API Source:
openstack_networks_rbac_policy_delete_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Name | Type | Required | Description |
|---|---|---|---|
rbac_policy_uuid |
string (uuid) | ✓ | UUID of the RBAC policy to delete |
uuid |
string (uuid) | ✓ |
204 - No response body
Openstack
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/openstack/discovery/ |
List Openstack Discovery |
| GET | /api/openstack/discovery/{id}/ |
Retrieve |
| POST | /api/openstack/discovery/ |
Create |
| PUT | /api/openstack/discovery/{id}/ |
Update |
| PATCH | /api/openstack/discovery/{id}/ |
Partial Update |
| DELETE | /api/openstack/discovery/{id}/ |
Delete |
| Other Actions | ||
| POST | /api/openstack/discovery/discover_external_networks/ |
Discover available external networks |
| POST | /api/openstack/discovery/discover_flavors/ |
Discover available flavors |
| POST | /api/openstack/discovery/discover_instance_availability_zones/ |
Discover available Nova instance availability zones |
| POST | /api/openstack/discovery/discover_volume_availability_zones/ |
Discover available Cinder volume availability zones |
| POST | /api/openstack/discovery/discover_volume_types/ |
Discover available volume types |
| POST | /api/openstack/discovery/preview_service_attributes/ |
Build service_attributes and plugin_options from selected values |
| POST | /api/openstack/discovery/validate_credentials/ |
Validate OpenStack credentials without saving them |
Core CRUD
List Openstack Discovery
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
- API Source:
openstack_discovery_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 - No response body
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_discovery_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required | Description |
|---|---|---|---|
id |
integer | ✓ | A unique integer value identifying this Service provider. |
200 - No response body
Create
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
- API Source:
openstack_discovery_create
1 2 3 4 5 6 7 8 9 10 | |
201 - No response body
Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_discovery_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required | Description |
|---|---|---|---|
id |
integer | ✓ | A unique integer value identifying this Service provider. |
200 - No response body
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_discovery_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required | Description |
|---|---|---|---|
id |
integer | ✓ | A unique integer value identifying this Service provider. |
200 - No response body
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_discovery_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required | Description |
|---|---|---|---|
id |
integer | ✓ | A unique integer value identifying this Service provider. |
204 - No response body
Other Actions
Discover available external networks
Discover available external networks.
1 2 3 4 5 6 7 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | |
- Model Source:
DiscoverExternalNetworksRequestRequest - API Source:
openstack_discovery_discover_external_networks
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
| Field | Type | Required | Description |
|---|---|---|---|
auth_url |
string (uri) | ✓ | Keystone auth URL (e.g., https://cloud.example.com:5000/v3) |
username |
string | ✓ | |
password |
string | ✓ | Constraints: write-only |
user_domain_name |
string | Keystone user domain name Constraints: default: Default |
|
project_domain_name |
string | Keystone project domain name Constraints: default: Default |
|
project_name |
string | Keystone project (tenant) name Constraints: default: admin |
|
verify_ssl |
boolean | Constraints: default: False |
|
certificate |
string | PEM-encoded CA certificate for SSL verification Constraints: write-only |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
id |
string |
name |
string |
is_shared |
boolean |
subnets |
array of objects |
subnets.id |
string |
subnets.name |
string |
subnets.cidr |
string |
subnets.gateway_ip |
string |
subnets.ip_version |
integer |
Discover available flavors
Discover available flavors.
1 2 3 4 5 6 7 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | |
- Model Source:
DiscoverFlavorsRequestRequest - API Source:
openstack_discovery_discover_flavors
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
| Field | Type | Required | Description |
|---|---|---|---|
auth_url |
string (uri) | ✓ | Keystone auth URL (e.g., https://cloud.example.com:5000/v3) |
username |
string | ✓ | |
password |
string | ✓ | Constraints: write-only |
user_domain_name |
string | Keystone user domain name Constraints: default: Default |
|
project_domain_name |
string | Keystone project domain name Constraints: default: Default |
|
project_name |
string | Keystone project (tenant) name Constraints: default: admin |
|
verify_ssl |
boolean | Constraints: default: False |
|
certificate |
string | PEM-encoded CA certificate for SSL verification Constraints: write-only |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
id |
string | |
name |
string | |
vcpus |
integer | |
ram |
integer | RAM in MB |
disk |
integer | Disk in GB |
Discover available Nova instance availability zones
Discover available Nova instance availability zones.
1 2 3 4 5 6 7 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | |
- Model Source:
DiscoverInstanceAvailabilityZonesRequestRequest - API Source:
openstack_discovery_discover_instance_availability_zones
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
| Field | Type | Required | Description |
|---|---|---|---|
auth_url |
string (uri) | ✓ | Keystone auth URL (e.g., https://cloud.example.com:5000/v3) |
username |
string | ✓ | |
password |
string | ✓ | Constraints: write-only |
user_domain_name |
string | Keystone user domain name Constraints: default: Default |
|
project_domain_name |
string | Keystone project domain name Constraints: default: Default |
|
project_name |
string | Keystone project (tenant) name Constraints: default: admin |
|
verify_ssl |
boolean | Constraints: default: False |
|
certificate |
string | PEM-encoded CA certificate for SSL verification Constraints: write-only |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
name |
string |
state |
string |
Discover available Cinder volume availability zones
Discover available Cinder volume availability zones.
1 2 3 4 5 6 7 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | |
- Model Source:
DiscoverVolumeAvailabilityZonesRequestRequest - API Source:
openstack_discovery_discover_volume_availability_zones
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
| Field | Type | Required | Description |
|---|---|---|---|
auth_url |
string (uri) | ✓ | Keystone auth URL (e.g., https://cloud.example.com:5000/v3) |
username |
string | ✓ | |
password |
string | ✓ | Constraints: write-only |
user_domain_name |
string | Keystone user domain name Constraints: default: Default |
|
project_domain_name |
string | Keystone project domain name Constraints: default: Default |
|
project_name |
string | Keystone project (tenant) name Constraints: default: admin |
|
verify_ssl |
boolean | Constraints: default: False |
|
certificate |
string | PEM-encoded CA certificate for SSL verification Constraints: write-only |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
name |
string |
state |
string |
Discover available volume types
Discover available volume types.
1 2 3 4 5 6 7 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | |
- Model Source:
DiscoverVolumeTypesRequestRequest - API Source:
openstack_discovery_discover_volume_types
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
| Field | Type | Required | Description |
|---|---|---|---|
auth_url |
string (uri) | ✓ | Keystone auth URL (e.g., https://cloud.example.com:5000/v3) |
username |
string | ✓ | |
password |
string | ✓ | Constraints: write-only |
user_domain_name |
string | Keystone user domain name Constraints: default: Default |
|
project_domain_name |
string | Keystone project domain name Constraints: default: Default |
|
project_name |
string | Keystone project (tenant) name Constraints: default: admin |
|
verify_ssl |
boolean | Constraints: default: False |
|
certificate |
string | PEM-encoded CA certificate for SSL verification Constraints: write-only |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
id |
string |
name |
string |
description |
string |
Build service_attributes and plugin_options from selected values
Build service_attributes and plugin_options from selected values.
1 2 3 4 5 6 7 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
PreviewServiceAttributesRequestRequest - API Source:
openstack_discovery_preview_service_attributes
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
| Field | Type | Required | Description |
|---|---|---|---|
auth_url |
string (uri) | ✓ | Keystone auth URL (e.g., https://cloud.example.com:5000/v3) |
username |
string | ✓ | |
password |
string | ✓ | Constraints: write-only |
user_domain_name |
string | Keystone user domain name Constraints: default: Default |
|
project_domain_name |
string | Keystone project domain name Constraints: default: Default |
|
project_name |
string | Keystone project (tenant) name Constraints: default: admin |
|
verify_ssl |
boolean | Constraints: default: False |
|
certificate |
string | PEM-encoded CA certificate for SSL verification Constraints: write-only |
|
external_network_id |
string | Selected external network ID Constraints: default: `` |
|
instance_availability_zone |
string | Selected instance availability zone name Constraints: default: `` |
|
volume_availability_zone |
string | Selected volume availability zone name Constraints: default: `` |
200 -
| Field | Type |
|---|---|
service_attributes |
object (free-form) |
plugin_options |
object (free-form) |
Validate OpenStack credentials without saving them
Validate OpenStack credentials without saving them.
1 2 3 4 5 6 7 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
OpenStackCredentialsRequest - API Source:
openstack_discovery_validate_credentials
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
| Field | Type | Required | Description |
|---|---|---|---|
auth_url |
string (uri) | ✓ | Keystone auth URL (e.g., https://cloud.example.com:5000/v3) |
username |
string | ✓ | |
password |
string | ✓ | Constraints: write-only |
user_domain_name |
string | Keystone user domain name Constraints: default: Default |
|
project_domain_name |
string | Keystone project domain name Constraints: default: Default |
|
project_name |
string | Keystone project (tenant) name Constraints: default: admin |
|
verify_ssl |
boolean | Constraints: default: False |
|
certificate |
string | PEM-encoded CA certificate for SSL verification Constraints: write-only |
200 -
| Field | Type |
|---|---|
valid |
boolean |
message |
string |
error |
string |
server_info |
any |
Openstack Ports
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/openstack-ports/ |
List ports |
| GET | /api/openstack-ports/{uuid}/ |
Get port details |
| POST | /api/openstack-ports/ |
Create port |
| POST | /api/openstack-ports/{uuid}/pull/ |
Synchronize resource state |
| POST | /api/openstack-ports/{uuid}/unlink/ |
Unlink resource |
| POST | /api/openstack-ports/{uuid}/update_port_ip/ |
Update port IP address |
| POST | /api/openstack-ports/{uuid}/update_security_groups/ |
Update port security groups |
| PUT | /api/openstack-ports/{uuid}/ |
Update port |
| PATCH | /api/openstack-ports/{uuid}/ |
Partially update port |
| DELETE | /api/openstack-ports/{uuid}/ |
Delete port |
| Other Actions | ||
| POST | /api/openstack-ports/{uuid}/disable_port/ |
Disable port |
| POST | /api/openstack-ports/{uuid}/disable_port_security/ |
Disable port security |
| POST | /api/openstack-ports/{uuid}/enable_port/ |
Enable port |
| POST | /api/openstack-ports/{uuid}/enable_port_security/ |
Enable port security |
| POST | /api/openstack-ports/{uuid}/set_erred/ |
Mark resource as ERRED |
| POST | /api/openstack-ports/{uuid}/set_ok/ |
Mark resource as OK |
Core CRUD
List ports
Get a list of network ports.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- Model Source:
OpenStackPortFieldEnum - Model Source:
OpenStackPortOEnum - API Source:
openstack_ports_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
admin_state_up |
boolean | |
backend_id |
string | |
device_id |
string | |
device_owner |
string | |
exclude_subnet_uuids |
string | Exclude Subnet UUIDs (comma-separated) |
field |
array | |
fixed_ips |
string | Search by fixed IP |
has_device_owner |
boolean | Has device owner |
mac_address |
string | |
name |
string | Name |
name_exact |
string | Name (exact) |
network_name |
string | Search by network name |
network_uuid |
string (uuid) | Search by network UUID |
o |
array | Ordering |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
query |
string | Search by name, MAC address or backend ID |
status |
string | |
tenant |
string (uri) | Tenant URL |
tenant_uuid |
string (uuid) | Tenant UUID |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | Port ID in OpenStack |
access_url |
string | |
fixed_ips |
array of objects | |
fixed_ips.ip_address |
any | IP address to assign to the port |
fixed_ips.subnet_id |
string | ID of the subnet in which to assign the IP address |
mac_address |
string | MAC address of the port |
allowed_address_pairs |
array of objects | |
allowed_address_pairs.mac_address |
string | |
tenant |
string (uri) | OpenStack tenant this port belongs to |
tenant_name |
string | |
tenant_uuid |
string (uuid) | |
network |
string (uri) | Network to which this port belongs |
network_name |
string | |
network_uuid |
string (uuid) | |
floating_ips |
array of string (uri)s | |
device_id |
string | ID of device (instance, router etc) to which this port is connected |
device_owner |
string | Entity that uses this port (e.g. network:router_interface) |
port_security_enabled |
boolean | If True, security groups and rules will be applied to this port |
security_groups |
array of objects | |
security_groups.uuid |
string (uuid) | |
security_groups.name |
string | |
security_groups.url |
string (uri) | |
admin_state_up |
boolean | Administrative state of the port. If down, port does not forward packets |
status |
string | Port status in OpenStack (e.g. ACTIVE, DOWN) |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Get port details
Retrieve details of a specific network port.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
OpenStackPortFieldEnum - API Source:
openstack_ports_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | Port ID in OpenStack |
access_url |
string | |
fixed_ips |
array of objects | |
fixed_ips.ip_address |
any | IP address to assign to the port |
fixed_ips.subnet_id |
string | ID of the subnet in which to assign the IP address |
mac_address |
string | MAC address of the port |
allowed_address_pairs |
array of objects | |
allowed_address_pairs.mac_address |
string | |
tenant |
string (uri) | OpenStack tenant this port belongs to |
tenant_name |
string | |
tenant_uuid |
string (uuid) | |
network |
string (uri) | Network to which this port belongs |
network_name |
string | |
network_uuid |
string (uuid) | |
floating_ips |
array of string (uri)s | |
device_id |
string | ID of device (instance, router etc) to which this port is connected |
device_owner |
string | Entity that uses this port (e.g. network:router_interface) |
port_security_enabled |
boolean | If True, security groups and rules will be applied to this port |
security_groups |
array of objects | |
security_groups.uuid |
string (uuid) | |
security_groups.name |
string | |
security_groups.url |
string (uri) | |
admin_state_up |
boolean | Administrative state of the port. If down, port does not forward packets |
status |
string | Port status in OpenStack (e.g. ACTIVE, DOWN) |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Create port
Create a new network port.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
- Model Source:
OpenStackPortRequest - API Source:
openstack_ports_create
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ✓ | |
description |
string | ||
fixed_ips |
array of objects | ||
fixed_ips.ip_address |
any | ✓ | IP address to assign to the port |
fixed_ips.subnet_id |
string | ✓ | ID of the subnet in which to assign the IP address |
mac_address |
string | MAC address of the port | |
allowed_address_pairs |
array of objects | ||
allowed_address_pairs.ip_address |
string | Constraints: write-only, default: 192.168.42.0/24 |
|
allowed_address_pairs.mac_address |
string | ||
target_tenant |
string (uri) | Target tenant for shared network port creation. If not specified, defaults to network's tenant. Constraints: write-only |
|
network |
string (uri) | Network to which this port belongs | |
port_security_enabled |
boolean | If True, security groups and rules will be applied to this port | |
security_groups |
array of objects | ||
security_groups.name |
string | ✓ |
201 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | Port ID in OpenStack |
access_url |
string | |
fixed_ips |
array of objects | |
fixed_ips.ip_address |
any | IP address to assign to the port |
fixed_ips.subnet_id |
string | ID of the subnet in which to assign the IP address |
mac_address |
string | MAC address of the port |
allowed_address_pairs |
array of objects | |
allowed_address_pairs.mac_address |
string | |
tenant |
string (uri) | OpenStack tenant this port belongs to |
tenant_name |
string | |
tenant_uuid |
string (uuid) | |
network |
string (uri) | Network to which this port belongs |
network_name |
string | |
network_uuid |
string (uuid) | |
floating_ips |
array of string (uri)s | |
device_id |
string | ID of device (instance, router etc) to which this port is connected |
device_owner |
string | Entity that uses this port (e.g. network:router_interface) |
port_security_enabled |
boolean | If True, security groups and rules will be applied to this port |
security_groups |
array of objects | |
security_groups.uuid |
string (uuid) | |
security_groups.name |
string | |
security_groups.url |
string (uri) | |
admin_state_up |
boolean | Administrative state of the port. If down, port does not forward packets |
status |
string | Port status in OpenStack (e.g. ACTIVE, DOWN) |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Synchronize resource state
Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_ports_pull
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
202 -
| Field | Type |
|---|---|
detail |
string |
409 -
| Field | Type |
|---|---|
detail |
string |
Unlink resource
Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_ports_unlink
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Update port IP address
Update port IP address.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
OpenStackPortIPUpdateRequest - API Source:
openstack_ports_update_port_ip
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
subnet |
string (uri) | ✓ | The subnet where the new IP address will be allocated Constraints: write-only |
ip_address |
any | ✓ | The IP address to assign within the subnet |
200 - No response body
Update port security groups
Update security groups of the port
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | |
- Model Source:
OpenStackInstanceSecurityGroupsUpdateRequest - API Source:
openstack_ports_update_security_groups
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
security_groups |
array of string (uri)s | ✓ | List of security groups to be assigned to the instance. |
200 - No response body
Update port
Update an existing network port.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
OpenStackPortRequest - API Source:
openstack_ports_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ✓ | |
description |
string | ||
fixed_ips |
array of objects | ||
fixed_ips.ip_address |
any | ✓ | IP address to assign to the port |
fixed_ips.subnet_id |
string | ✓ | ID of the subnet in which to assign the IP address |
mac_address |
string | MAC address of the port | |
allowed_address_pairs |
array of objects | ||
allowed_address_pairs.ip_address |
string | Constraints: write-only, default: 192.168.42.0/24 |
|
allowed_address_pairs.mac_address |
string | ||
target_tenant |
string (uri) | Target tenant for shared network port creation. If not specified, defaults to network's tenant. Constraints: write-only |
|
network |
string (uri) | Network to which this port belongs | |
port_security_enabled |
boolean | If True, security groups and rules will be applied to this port | |
security_groups |
array of objects | ||
security_groups.name |
string | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | Port ID in OpenStack |
access_url |
string | |
fixed_ips |
array of objects | |
fixed_ips.ip_address |
any | IP address to assign to the port |
fixed_ips.subnet_id |
string | ID of the subnet in which to assign the IP address |
mac_address |
string | MAC address of the port |
allowed_address_pairs |
array of objects | |
allowed_address_pairs.mac_address |
string | |
tenant |
string (uri) | OpenStack tenant this port belongs to |
tenant_name |
string | |
tenant_uuid |
string (uuid) | |
network |
string (uri) | Network to which this port belongs |
network_name |
string | |
network_uuid |
string (uuid) | |
floating_ips |
array of string (uri)s | |
device_id |
string | ID of device (instance, router etc) to which this port is connected |
device_owner |
string | Entity that uses this port (e.g. network:router_interface) |
port_security_enabled |
boolean | If True, security groups and rules will be applied to this port |
security_groups |
array of objects | |
security_groups.uuid |
string (uuid) | |
security_groups.name |
string | |
security_groups.url |
string (uri) | |
admin_state_up |
boolean | Administrative state of the port. If down, port does not forward packets |
status |
string | Port status in OpenStack (e.g. ACTIVE, DOWN) |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Partially update port
Update specific fields of a network port.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedOpenStackPortRequest - API Source:
openstack_ports_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ||
description |
string | ||
target_tenant |
string (uri) | Target tenant for shared network port creation. If not specified, defaults to network's tenant. Constraints: write-only |
|
security_groups |
array of objects | ||
security_groups.name |
string | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | Port ID in OpenStack |
access_url |
string | |
fixed_ips |
array of objects | |
fixed_ips.ip_address |
any | IP address to assign to the port |
fixed_ips.subnet_id |
string | ID of the subnet in which to assign the IP address |
mac_address |
string | MAC address of the port |
allowed_address_pairs |
array of objects | |
allowed_address_pairs.mac_address |
string | |
tenant |
string (uri) | OpenStack tenant this port belongs to |
tenant_name |
string | |
tenant_uuid |
string (uuid) | |
network |
string (uri) | Network to which this port belongs |
network_name |
string | |
network_uuid |
string (uuid) | |
floating_ips |
array of string (uri)s | |
device_id |
string | ID of device (instance, router etc) to which this port is connected |
device_owner |
string | Entity that uses this port (e.g. network:router_interface) |
port_security_enabled |
boolean | If True, security groups and rules will be applied to this port |
security_groups |
array of objects | |
security_groups.uuid |
string (uuid) | |
security_groups.name |
string | |
security_groups.url |
string (uri) | |
admin_state_up |
boolean | Administrative state of the port. If down, port does not forward packets |
status |
string | Port status in OpenStack (e.g. ACTIVE, DOWN) |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Delete port
Delete a network port.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_ports_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
Disable port
Disable port.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_ports_disable_port
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - No response body
Disable port security
Disable port security for the port
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_ports_disable_port_security
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - No response body
Enable port
Enable port.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_ports_enable_port
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - No response body
Enable port security
Enable port security for the port
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_ports_enable_port_security
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - No response body
Mark resource as ERRED
Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
SetErredRequest - API Source:
openstack_ports_set_erred
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
error_message |
string | |
error_traceback |
string |
200 -
| Field | Type |
|---|---|
detail |
string |
Mark resource as OK
Manually transition the resource to OK state and clear error fields. Staff-only operation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_ports_set_ok
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
detail |
string |
Openstack Routers
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/openstack-routers/ |
List routers |
| GET | /api/openstack-routers/{uuid}/ |
Get router details |
| POST | /api/openstack-routers/ |
Create router |
| DELETE | /api/openstack-routers/{uuid}/ |
Delete router |
| Other Actions | ||
| POST | /api/openstack-routers/{uuid}/add_router_interface/ |
Add router interface |
| POST | /api/openstack-routers/{uuid}/remove_router_interface/ |
Remove router interface |
| POST | /api/openstack-routers/{uuid}/set_erred/ |
Mark router as ERRED |
| POST | /api/openstack-routers/{uuid}/set_ok/ |
Mark router as OK |
| POST | /api/openstack-routers/{uuid}/set_routes/ |
Set static routes |
Core CRUD
List routers
Get a list of routers.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- Model Source:
CoreStates - Model Source:
OpenStackRouterFieldEnum - API Source:
openstack_routers_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
field |
array | |
name |
string | Name |
name_exact |
string | Name (exact) |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
state |
array | State |
tenant |
string (uri) | Tenant URL |
tenant_uuid |
string (uuid) | Tenant UUID |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | Router ID in OpenStack |
access_url |
string | |
tenant |
string (uri) | OpenStack tenant this router belongs to |
tenant_name |
string | |
tenant_uuid |
string (uuid) | |
routes |
array of objects | |
routes.destination |
string | |
routes.nexthop |
any | An IPv4 or IPv6 address. |
fixed_ips |
array of objects | |
fixed_ips.ip_address |
any | IP address to assign to the port |
fixed_ips.subnet_id |
string | ID of the subnet in which to assign the IP address |
ports |
array of objects | |
ports.url |
string (uri) | |
ports.fixed_ips |
array of objects | |
ports.fixed_ips.ip_address |
any | IP address to assign to the port |
ports.fixed_ips.subnet_id |
string | ID of the subnet in which to assign the IP address |
ports.mac_address |
string | MAC address of the port |
ports.subnet |
string (uri) | Subnet to which this port belongs |
ports.subnet_uuid |
string (uuid) | |
ports.subnet_name |
string | |
ports.subnet_description |
string | |
ports.subnet_cidr |
string | IPv4 network address in CIDR format (e.g. 192.168.0.0/24) |
ports.allowed_address_pairs |
array of objects | |
ports.allowed_address_pairs.mac_address |
string | |
ports.device_id |
string | ID of device (instance, router etc) to which this port is connected |
ports.device_owner |
string | Entity that uses this port (e.g. network:router_interface) |
ports.security_groups |
array of objects | |
ports.security_groups.url |
string (uri) | |
ports.security_groups.uuid |
string (uuid) | |
ports.security_groups.name |
string | |
ports.security_groups.description |
string | |
ports.security_groups.service_name |
string | |
ports.security_groups.service_settings |
string (uri) | |
ports.security_groups.service_settings_uuid |
string (uuid) | |
ports.security_groups.service_settings_state |
string | |
ports.security_groups.service_settings_error_message |
string | |
ports.security_groups.project |
string (uri) | |
ports.security_groups.project_name |
string | |
ports.security_groups.project_uuid |
string (uuid) | |
ports.security_groups.customer |
string (uri) | |
ports.security_groups.customer_uuid |
string (uuid) | |
ports.security_groups.customer_name |
string | |
ports.security_groups.customer_native_name |
string | |
ports.security_groups.customer_abbreviation |
string | |
ports.security_groups.error_message |
string | |
ports.security_groups.error_traceback |
string | |
ports.security_groups.resource_type |
string | |
ports.security_groups.state |
any | |
ports.security_groups.created |
string (date-time) | |
ports.security_groups.modified |
string (date-time) | |
ports.security_groups.backend_id |
string | |
ports.security_groups.access_url |
string | |
ports.security_groups.tenant |
string (uri) | |
ports.security_groups.tenant_name |
string | |
ports.security_groups.tenant_uuid |
string (uuid) | |
ports.security_groups.rules |
array of objects | |
ports.security_groups.rules.ethertype |
any | IP protocol version - either 'IPv4' or 'IPv6' |
ports.security_groups.rules.direction |
any | Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing) |
ports.security_groups.rules.protocol |
any | The network protocol (TCP, UDP, ICMP, or empty for any protocol) |
ports.security_groups.rules.from_port |
integer | Starting port number in the range (1-65535) |
ports.security_groups.rules.to_port |
integer | Ending port number in the range (1-65535) |
ports.security_groups.rules.cidr |
string | CIDR notation for the source/destination network address range |
ports.security_groups.rules.description |
string | |
ports.security_groups.rules.remote_group_name |
string | |
ports.security_groups.rules.remote_group_uuid |
string (uuid) | |
ports.security_groups.rules.id |
integer | |
ports.security_groups.rules.remote_group |
string (uri) | Remote security group that this rule references, if any |
ports.security_groups.marketplace_offering_uuid |
string | |
ports.security_groups.marketplace_offering_name |
string | |
ports.security_groups.marketplace_offering_plugin_options |
object (free-form) | |
ports.security_groups.marketplace_category_uuid |
string | |
ports.security_groups.marketplace_category_name |
string | |
ports.security_groups.marketplace_resource_uuid |
string | |
ports.security_groups.marketplace_plan_uuid |
string | |
ports.security_groups.marketplace_resource_state |
string | |
ports.security_groups.is_usage_based |
boolean | |
ports.security_groups.is_limit_based |
boolean | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean | |
offering_external_ips |
array of strings |
Get router details
Retrieve details of a specific router.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
OpenStackRouterFieldEnum - API Source:
openstack_routers_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | Router ID in OpenStack |
access_url |
string | |
tenant |
string (uri) | OpenStack tenant this router belongs to |
tenant_name |
string | |
tenant_uuid |
string (uuid) | |
routes |
array of objects | |
routes.destination |
string | |
routes.nexthop |
any | An IPv4 or IPv6 address. |
fixed_ips |
array of objects | |
fixed_ips.ip_address |
any | IP address to assign to the port |
fixed_ips.subnet_id |
string | ID of the subnet in which to assign the IP address |
ports |
array of objects | |
ports.url |
string (uri) | |
ports.fixed_ips |
array of objects | |
ports.fixed_ips.ip_address |
any | IP address to assign to the port |
ports.fixed_ips.subnet_id |
string | ID of the subnet in which to assign the IP address |
ports.mac_address |
string | MAC address of the port |
ports.subnet |
string (uri) | Subnet to which this port belongs |
ports.subnet_uuid |
string (uuid) | |
ports.subnet_name |
string | |
ports.subnet_description |
string | |
ports.subnet_cidr |
string | IPv4 network address in CIDR format (e.g. 192.168.0.0/24) |
ports.allowed_address_pairs |
array of objects | |
ports.allowed_address_pairs.mac_address |
string | |
ports.device_id |
string | ID of device (instance, router etc) to which this port is connected |
ports.device_owner |
string | Entity that uses this port (e.g. network:router_interface) |
ports.security_groups |
array of objects | |
ports.security_groups.url |
string (uri) | |
ports.security_groups.uuid |
string (uuid) | |
ports.security_groups.name |
string | |
ports.security_groups.description |
string | |
ports.security_groups.service_name |
string | |
ports.security_groups.service_settings |
string (uri) | |
ports.security_groups.service_settings_uuid |
string (uuid) | |
ports.security_groups.service_settings_state |
string | |
ports.security_groups.service_settings_error_message |
string | |
ports.security_groups.project |
string (uri) | |
ports.security_groups.project_name |
string | |
ports.security_groups.project_uuid |
string (uuid) | |
ports.security_groups.customer |
string (uri) | |
ports.security_groups.customer_uuid |
string (uuid) | |
ports.security_groups.customer_name |
string | |
ports.security_groups.customer_native_name |
string | |
ports.security_groups.customer_abbreviation |
string | |
ports.security_groups.error_message |
string | |
ports.security_groups.error_traceback |
string | |
ports.security_groups.resource_type |
string | |
ports.security_groups.state |
any | |
ports.security_groups.created |
string (date-time) | |
ports.security_groups.modified |
string (date-time) | |
ports.security_groups.backend_id |
string | |
ports.security_groups.access_url |
string | |
ports.security_groups.tenant |
string (uri) | |
ports.security_groups.tenant_name |
string | |
ports.security_groups.tenant_uuid |
string (uuid) | |
ports.security_groups.rules |
array of objects | |
ports.security_groups.rules.ethertype |
any | IP protocol version - either 'IPv4' or 'IPv6' |
ports.security_groups.rules.direction |
any | Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing) |
ports.security_groups.rules.protocol |
any | The network protocol (TCP, UDP, ICMP, or empty for any protocol) |
ports.security_groups.rules.from_port |
integer | Starting port number in the range (1-65535) |
ports.security_groups.rules.to_port |
integer | Ending port number in the range (1-65535) |
ports.security_groups.rules.cidr |
string | CIDR notation for the source/destination network address range |
ports.security_groups.rules.description |
string | |
ports.security_groups.rules.remote_group_name |
string | |
ports.security_groups.rules.remote_group_uuid |
string (uuid) | |
ports.security_groups.rules.id |
integer | |
ports.security_groups.rules.remote_group |
string (uri) | Remote security group that this rule references, if any |
ports.security_groups.marketplace_offering_uuid |
string | |
ports.security_groups.marketplace_offering_name |
string | |
ports.security_groups.marketplace_offering_plugin_options |
object (free-form) | |
ports.security_groups.marketplace_category_uuid |
string | |
ports.security_groups.marketplace_category_name |
string | |
ports.security_groups.marketplace_resource_uuid |
string | |
ports.security_groups.marketplace_plan_uuid |
string | |
ports.security_groups.marketplace_resource_state |
string | |
ports.security_groups.is_usage_based |
boolean | |
ports.security_groups.is_limit_based |
boolean | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean | |
offering_external_ips |
array of strings |
Create router
Create a new router.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
CreateRouterRequest - API Source:
openstack_routers_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Field | Type | Required | Description |
|---|---|---|---|
tenant |
string (uri) | ✓ | OpenStack tenant this router belongs to |
name |
string | ✓ |
201 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
tenant |
string (uri) | OpenStack tenant this router belongs to |
name |
string | |
project |
string (uri) | |
service_settings |
string (uri) |
Delete router
Delete a router.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_routers_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
Add router interface
Add interface to router. Either subnet or port must be provided.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
OpenStackRouterInterfaceRequest - API Source:
openstack_routers_add_router_interface
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
subnet |
string (uri) | The subnet to connect to the router. Either subnet or port must be specified, but not both. | |
port |
string (uri) | The port to connect to the router. Either subnet or port must be specified, but not both. |
200 - No response body
Remove router interface
Remove interface from router. Either subnet or port must be provided.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
OpenStackRouterInterfaceRequest - API Source:
openstack_routers_remove_router_interface
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
subnet |
string (uri) | The subnet to connect to the router. Either subnet or port must be specified, but not both. | |
port |
string (uri) | The port to connect to the router. Either subnet or port must be specified, but not both. |
200 - No response body
Mark router as ERRED
Manually transition the router to ERRED state. This is useful for routers stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
SetErredRequest - API Source:
openstack_routers_set_erred
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
error_message |
string | |
error_traceback |
string |
200 -
| Field | Type |
|---|---|
detail |
string |
Mark router as OK
Manually transition the router to OK state and clear error fields. Staff-only operation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_routers_set_ok
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
detail |
string |
Set static routes
Define or overwrite the static routes for the router.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
OpenStackRouterSetRoutesRequest - API Source:
openstack_routers_set_routes
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
routes |
array of objects | ✓ | |
routes.destination |
string | ✓ | |
routes.nexthop |
any | ✓ | An IPv4 or IPv6 address. |
200 -
| Field | Type | Description |
|---|---|---|
routes |
array of objects | |
routes.destination |
string | |
routes.nexthop |
any | An IPv4 or IPv6 address. |
Openstack Security Groups
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/openstack-security-groups/ |
List security groups |
| GET | /api/openstack-security-groups/{uuid}/ |
Get security group details |
| POST | /api/openstack-security-groups/{uuid}/pull/ |
Synchronize resource state |
| POST | /api/openstack-security-groups/{uuid}/unlink/ |
Unlink resource |
| PUT | /api/openstack-security-groups/{uuid}/ |
Update |
| PATCH | /api/openstack-security-groups/{uuid}/ |
Partially update security group |
| DELETE | /api/openstack-security-groups/{uuid}/ |
Delete security group |
| Other Actions | ||
| POST | /api/openstack-security-groups/{uuid}/set_erred/ |
Mark resource as ERRED |
| POST | /api/openstack-security-groups/{uuid}/set_ok/ |
Mark resource as OK |
| POST | /api/openstack-security-groups/{uuid}/set_rules/ |
Set security group rules |
Core CRUD
List security groups
Get a list of security groups.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- Model Source:
CoreStates - Model Source:
OpenStackSecurityGroupFieldEnum - API Source:
openstack_security_groups_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
backend_id |
string | Backend ID |
can_manage |
boolean | Can manage |
customer |
string (uuid) | Customer UUID |
customer_abbreviation |
string | Customer abbreviation |
customer_name |
string | Customer name |
customer_native_name |
string | Customer native name |
customer_uuid |
string (uuid) | Customer UUID |
description |
string | Description |
external_ip |
string | External IP |
field |
array | |
name |
string | Name |
name_exact |
string | Name (exact) |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
project |
string (uuid) | Project UUID |
project_name |
string | Project name |
project_uuid |
string (uuid) | Project UUID |
query |
string | Search by name or description |
service_settings_name |
string | Service settings name |
service_settings_uuid |
string (uuid) | Service settings UUID |
state |
array | State |
tenant |
string (uri) | Tenant URL |
tenant_uuid |
string (uuid) | Tenant UUID |
uuid |
string (uuid) | UUID |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
tenant |
string (uri) | |
tenant_name |
string | |
tenant_uuid |
string (uuid) | |
rules |
array of objects | |
rules.ethertype |
any | IP protocol version - either 'IPv4' or 'IPv6' |
rules.direction |
any | Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing) |
rules.protocol |
any | The network protocol (TCP, UDP, ICMP, or empty for any protocol) |
rules.from_port |
integer | Starting port number in the range (1-65535) |
rules.to_port |
integer | Ending port number in the range (1-65535) |
rules.cidr |
string | CIDR notation for the source/destination network address range |
rules.description |
string | |
rules.remote_group_name |
string | |
rules.remote_group_uuid |
string (uuid) | |
rules.id |
integer | |
rules.remote_group |
string (uri) | Remote security group that this rule references, if any |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Get security group details
Retrieve details of a specific security group.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
OpenStackSecurityGroupFieldEnum - API Source:
openstack_security_groups_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
tenant |
string (uri) | |
tenant_name |
string | |
tenant_uuid |
string (uuid) | |
rules |
array of objects | |
rules.ethertype |
any | IP protocol version - either 'IPv4' or 'IPv6' |
rules.direction |
any | Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing) |
rules.protocol |
any | The network protocol (TCP, UDP, ICMP, or empty for any protocol) |
rules.from_port |
integer | Starting port number in the range (1-65535) |
rules.to_port |
integer | Ending port number in the range (1-65535) |
rules.cidr |
string | CIDR notation for the source/destination network address range |
rules.description |
string | |
rules.remote_group_name |
string | |
rules.remote_group_uuid |
string (uuid) | |
rules.id |
integer | |
rules.remote_group |
string (uri) | Remote security group that this rule references, if any |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Synchronize resource state
Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_security_groups_pull
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
202 -
| Field | Type |
|---|---|
detail |
string |
409 -
| Field | Type |
|---|---|
detail |
string |
Unlink resource
Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_security_groups_unlink
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Update
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
OpenStackSecurityGroupUpdateRequest - API Source:
openstack_security_groups_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
name |
string | ✓ |
description |
string |
200 -
| Field | Type |
|---|---|
name |
string |
description |
string |
Partially update security group
Update specific fields of a security group.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedOpenStackSecurityGroupUpdateRequest - API Source:
openstack_security_groups_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
name |
string | |
description |
string |
200 -
| Field | Type |
|---|---|
name |
string |
description |
string |
Delete security group
Delete a security group.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_security_groups_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
Mark resource as ERRED
Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
SetErredRequest - API Source:
openstack_security_groups_set_erred
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
error_message |
string | |
error_traceback |
string |
200 -
| Field | Type |
|---|---|
detail |
string |
Mark resource as OK
Manually transition the resource to OK state and clear error fields. Staff-only operation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_security_groups_set_ok
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
detail |
string |
Set security group rules
Update the rules for a specific security group. This overwrites all existing rules.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_security_groups_set_rules
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
The request body is an array of objects, where each object has the following structure:
| Field | Type | Required | Description |
|---|---|---|---|
ethertype |
any | IP protocol version - either 'IPv4' or 'IPv6' Constraints: default: IPv4 |
|
direction |
any | Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing) Constraints: default: ingress |
|
protocol |
any | The network protocol (TCP, UDP, ICMP, or empty for any protocol) | |
from_port |
integer | Starting port number in the range (1-65535) | |
to_port |
integer | Ending port number in the range (1-65535) | |
cidr |
string | CIDR notation for the source/destination network address range | |
description |
string | ||
remote_group |
string (uri) | Remote security group that this rule references, if any |
200 - No response body
Openstack Server Groups
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/openstack-server-groups/ |
List server groups |
| GET | /api/openstack-server-groups/{uuid}/ |
Get server group details |
| POST | /api/openstack-server-groups/ |
Create |
| POST | /api/openstack-server-groups/{uuid}/pull/ |
Synchronize resource state |
| POST | /api/openstack-server-groups/{uuid}/unlink/ |
Unlink resource |
| DELETE | /api/openstack-server-groups/{uuid}/ |
Delete server group |
| Other Actions | ||
| POST | /api/openstack-server-groups/{uuid}/set_erred/ |
Mark resource as ERRED |
| POST | /api/openstack-server-groups/{uuid}/set_ok/ |
Mark resource as OK |
Core CRUD
List server groups
Get a list of server groups.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- Model Source:
CoreStates - Model Source:
OpenStackServerGroupFieldEnum - API Source:
openstack_server_groups_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
backend_id |
string | Backend ID |
can_manage |
boolean | Can manage |
customer |
string (uuid) | Customer UUID |
customer_abbreviation |
string | Customer abbreviation |
customer_name |
string | Customer name |
customer_native_name |
string | Customer native name |
customer_uuid |
string (uuid) | Customer UUID |
description |
string | Description |
external_ip |
string | External IP |
field |
array | |
name |
string | Name |
name_exact |
string | Name (exact) |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
project |
string (uuid) | Project UUID |
project_name |
string | Project name |
project_uuid |
string (uuid) | Project UUID |
service_settings_name |
string | Service settings name |
service_settings_uuid |
string (uuid) | Service settings UUID |
state |
array | State |
tenant |
string (uri) | Tenant URL |
tenant_uuid |
string (uuid) | Tenant UUID |
uuid |
string (uuid) | UUID |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
tenant |
string (uri) | |
tenant_name |
string | |
tenant_uuid |
string (uuid) | |
policy |
any | affinity — all instances are placed on the same hypervisor. anti-affinity — all instances are placed on different hypervisors. soft-affinity — instances are placed on the same hypervisor if possible, but not enforced. soft-anti-affinity — instances are placed on different hypervisors if possible, but not enforced. |
display_name |
string | |
instances |
array of objects | |
instances.backend_id |
string | Instance ID in the OpenStack backend |
instances.name |
string | |
instances.uuid |
string (uuid) | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Get server group details
Retrieve details of a specific server group.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
OpenStackServerGroupFieldEnum - API Source:
openstack_server_groups_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
tenant |
string (uri) | |
tenant_name |
string | |
tenant_uuid |
string (uuid) | |
policy |
any | affinity — all instances are placed on the same hypervisor. anti-affinity — all instances are placed on different hypervisors. soft-affinity — instances are placed on the same hypervisor if possible, but not enforced. soft-anti-affinity — instances are placed on different hypervisors if possible, but not enforced. |
display_name |
string | |
instances |
array of objects | |
instances.backend_id |
string | Instance ID in the OpenStack backend |
instances.name |
string | |
instances.uuid |
string (uuid) | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Create
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
- Model Source:
OpenStackServerGroupRequest - API Source:
openstack_server_groups_create
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ✓ | |
description |
string | ||
policy |
any | affinity — all instances are placed on the same hypervisor. anti-affinity — all instances are placed on different hypervisors. soft-affinity — instances are placed on the same hypervisor if possible, but not enforced. soft-anti-affinity — instances are placed on different hypervisors if possible, but not enforced. |
201 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
tenant |
string (uri) | |
tenant_name |
string | |
tenant_uuid |
string (uuid) | |
policy |
any | affinity — all instances are placed on the same hypervisor. anti-affinity — all instances are placed on different hypervisors. soft-affinity — instances are placed on the same hypervisor if possible, but not enforced. soft-anti-affinity — instances are placed on different hypervisors if possible, but not enforced. |
display_name |
string | |
instances |
array of objects | |
instances.backend_id |
string | Instance ID in the OpenStack backend |
instances.name |
string | |
instances.uuid |
string (uuid) | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Synchronize resource state
Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_server_groups_pull
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
202 -
| Field | Type |
|---|---|
detail |
string |
409 -
| Field | Type |
|---|---|
detail |
string |
Unlink resource
Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_server_groups_unlink
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Delete server group
Delete a server group.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_server_groups_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
Mark resource as ERRED
Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
SetErredRequest - API Source:
openstack_server_groups_set_erred
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
error_message |
string | |
error_traceback |
string |
200 -
| Field | Type |
|---|---|
detail |
string |
Mark resource as OK
Manually transition the resource to OK state and clear error fields. Staff-only operation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_server_groups_set_ok
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
detail |
string |
Openstack Snapshots
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/openstack-snapshots/ |
List snapshots |
| GET | /api/openstack-snapshots/{uuid}/ |
Get snapshot details |
| POST | /api/openstack-snapshots/{uuid}/pull/ |
Synchronize resource state |
| POST | /api/openstack-snapshots/{uuid}/unlink/ |
Unlink resource |
| PUT | /api/openstack-snapshots/{uuid}/ |
Update snapshot |
| PATCH | /api/openstack-snapshots/{uuid}/ |
Partially update snapshot |
| DELETE | /api/openstack-snapshots/{uuid}/ |
Delete snapshot |
| Other Actions | ||
| GET | /api/openstack-snapshots/{uuid}/restorations/ |
List snapshot restorations |
| POST | /api/openstack-snapshots/{uuid}/restore/ |
Restore volume from snapshot |
| POST | /api/openstack-snapshots/{uuid}/set_erred/ |
Mark resource as ERRED |
| POST | /api/openstack-snapshots/{uuid}/set_ok/ |
Mark resource as OK |
Core CRUD
List snapshots
Get a list of snapshots.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- Model Source:
CoreStates - Model Source:
OpenStackSnapshotFieldEnum - API Source:
openstack_snapshots_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
backend_id |
string | Backend ID |
backup |
string (uri) | Backup URL |
backup_uuid |
string (uuid) | Backup UUID |
can_manage |
boolean | Can manage |
customer |
string (uuid) | Customer UUID |
customer_abbreviation |
string | Customer abbreviation |
customer_name |
string | Customer name |
customer_native_name |
string | Customer native name |
customer_uuid |
string (uuid) | Customer UUID |
description |
string | Description |
external_ip |
string | External IP |
field |
array | |
name |
string | Name |
name_exact |
string | Name (exact) |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
project |
string (uuid) | Project UUID |
project_name |
string | Project name |
project_uuid |
string (uuid) | Project UUID |
runtime_state |
string | |
service_settings_name |
string | Service settings name |
service_settings_uuid |
string (uuid) | Service settings UUID |
source_volume |
string (uri) | Source volume URL |
source_volume_uuid |
string (uuid) | Source volume UUID |
state |
array | State |
tenant |
string (uri) | Tenant URL |
tenant_uuid |
string (uuid) | Tenant UUID |
uuid |
string (uuid) | UUID |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | Snapshot ID in the OpenStack backend |
access_url |
string | |
source_volume |
string (uri) | Volume from which this snapshot was created |
size |
integer | Size in MiB |
metadata |
any | |
runtime_state |
string | |
source_volume_name |
string | |
source_volume_marketplace_uuid |
string (uuid) | |
action |
string | |
action_details |
any | |
restorations |
array of objects | |
restorations.uuid |
string (uuid) | |
restorations.created |
string (date-time) | |
restorations.description |
string | New volume description. |
restorations.volume |
string (uri) | Volume that is being restored from the snapshot |
restorations.volume_name |
string | |
restorations.volume_state |
string | |
restorations.volume_runtime_state |
string | |
restorations.volume_size |
integer | Size in MiB |
restorations.volume_device |
string | Name of volume as instance device e.g. /dev/vdb. |
kept_until |
string (date-time) | Guaranteed time of snapshot retention. If null - keep forever. |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Get snapshot details
Retrieve details of a specific snapshot.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
OpenStackSnapshotFieldEnum - API Source:
openstack_snapshots_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | Snapshot ID in the OpenStack backend |
access_url |
string | |
source_volume |
string (uri) | Volume from which this snapshot was created |
size |
integer | Size in MiB |
metadata |
any | |
runtime_state |
string | |
source_volume_name |
string | |
source_volume_marketplace_uuid |
string (uuid) | |
action |
string | |
action_details |
any | |
restorations |
array of objects | |
restorations.uuid |
string (uuid) | |
restorations.created |
string (date-time) | |
restorations.description |
string | New volume description. |
restorations.volume |
string (uri) | Volume that is being restored from the snapshot |
restorations.volume_name |
string | |
restorations.volume_state |
string | |
restorations.volume_runtime_state |
string | |
restorations.volume_size |
integer | Size in MiB |
restorations.volume_device |
string | Name of volume as instance device e.g. /dev/vdb. |
kept_until |
string (date-time) | Guaranteed time of snapshot retention. If null - keep forever. |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Synchronize resource state
Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_snapshots_pull
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
202 -
| Field | Type |
|---|---|
detail |
string |
409 -
| Field | Type |
|---|---|
detail |
string |
Unlink resource
Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_snapshots_unlink
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Update snapshot
Update an existing snapshot.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
OpenStackSnapshotRequest - API Source:
openstack_snapshots_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ✓ | |
description |
string | ||
metadata |
any | ||
kept_until |
string (date-time) | Guaranteed time of snapshot retention. If null - keep forever. |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | Snapshot ID in the OpenStack backend |
access_url |
string | |
source_volume |
string (uri) | Volume from which this snapshot was created |
size |
integer | Size in MiB |
metadata |
any | |
runtime_state |
string | |
source_volume_name |
string | |
source_volume_marketplace_uuid |
string (uuid) | |
action |
string | |
action_details |
any | |
restorations |
array of objects | |
restorations.uuid |
string (uuid) | |
restorations.created |
string (date-time) | |
restorations.description |
string | New volume description. |
restorations.volume |
string (uri) | Volume that is being restored from the snapshot |
restorations.volume_name |
string | |
restorations.volume_state |
string | |
restorations.volume_runtime_state |
string | |
restorations.volume_size |
integer | Size in MiB |
restorations.volume_device |
string | Name of volume as instance device e.g. /dev/vdb. |
kept_until |
string (date-time) | Guaranteed time of snapshot retention. If null - keep forever. |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Partially update snapshot
Update specific fields of a snapshot.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedOpenStackSnapshotRequest - API Source:
openstack_snapshots_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ||
description |
string | ||
metadata |
any | ||
kept_until |
string (date-time) | Guaranteed time of snapshot retention. If null - keep forever. |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | Snapshot ID in the OpenStack backend |
access_url |
string | |
source_volume |
string (uri) | Volume from which this snapshot was created |
size |
integer | Size in MiB |
metadata |
any | |
runtime_state |
string | |
source_volume_name |
string | |
source_volume_marketplace_uuid |
string (uuid) | |
action |
string | |
action_details |
any | |
restorations |
array of objects | |
restorations.uuid |
string (uuid) | |
restorations.created |
string (date-time) | |
restorations.description |
string | New volume description. |
restorations.volume |
string (uri) | Volume that is being restored from the snapshot |
restorations.volume_name |
string | |
restorations.volume_state |
string | |
restorations.volume_runtime_state |
string | |
restorations.volume_size |
integer | Size in MiB |
restorations.volume_device |
string | Name of volume as instance device e.g. /dev/vdb. |
kept_until |
string (date-time) | Guaranteed time of snapshot retention. If null - keep forever. |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Delete snapshot
Delete a snapshot.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_snapshots_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
List snapshot restorations
Get a list of snapshot restorations
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- API Source:
openstack_snapshots_restorations_list
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
created |
string (date-time) | |
description |
string | New volume description. |
volume |
string (uri) | Volume that is being restored from the snapshot |
volume_name |
string | |
volume_state |
string | |
volume_runtime_state |
string | |
volume_size |
integer | Size in MiB |
volume_device |
string | Name of volume as instance device e.g. /dev/vdb. |
Restore volume from snapshot
Restore volume from snapshot
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
OpenStackSnapshotRestorationRequest - API Source:
openstack_snapshots_restore
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ✓ | New volume name. Constraints: write-only |
description |
string | New volume description. |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | Volume ID in the OpenStack backend |
access_url |
string | |
source_snapshot |
string (uri) | Snapshot that this volume was created from, if any |
size |
integer | Size in MiB |
bootable |
boolean | Indicates if this volume can be used to boot an instance |
metadata |
any | |
image |
string (uri) | Image that this volume was created from, if any |
image_metadata |
string | Metadata of the image this volume was created from |
image_name |
string | Name of the image this volume was created from |
type |
string (uri) | Type of the volume (e.g. SSD, HDD) |
type_name |
string | |
runtime_state |
string | |
availability_zone |
string (uri) | Availability zone where this volume is located |
availability_zone_name |
string | |
device |
string | Name of volume as instance device e.g. /dev/vdb. |
action |
string | |
action_details |
any | |
instance |
string (uri) | Instance that this volume is attached to, if any |
instance_name |
string | |
instance_marketplace_uuid |
string (uuid) | |
tenant |
string (uri) | |
tenant_uuid |
string (uuid) | |
extend_enabled |
boolean | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Mark resource as ERRED
Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
SetErredRequest - API Source:
openstack_snapshots_set_erred
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
error_message |
string | |
error_traceback |
string |
200 -
| Field | Type |
|---|---|
detail |
string |
Mark resource as OK
Manually transition the resource to OK state and clear error fields. Staff-only operation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_snapshots_set_ok
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
detail |
string |
Openstack Subnets
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/openstack-subnets/ |
List subnets |
| GET | /api/openstack-subnets/{uuid}/ |
Get subnet details |
| POST | /api/openstack-subnets/{uuid}/pull/ |
Synchronize resource state |
| POST | /api/openstack-subnets/{uuid}/unlink/ |
Unlink resource |
| PUT | /api/openstack-subnets/{uuid}/ |
Update subnet |
| PATCH | /api/openstack-subnets/{uuid}/ |
Partially update subnet |
| DELETE | /api/openstack-subnets/{uuid}/ |
Delete subnet |
| Other Actions | ||
| POST | /api/openstack-subnets/{uuid}/connect/ |
Connect subnet to router |
| POST | /api/openstack-subnets/{uuid}/disconnect/ |
Disconnect subnet from router |
| POST | /api/openstack-subnets/{uuid}/set_erred/ |
Mark resource as ERRED |
| POST | /api/openstack-subnets/{uuid}/set_ok/ |
Mark resource as OK |
Core CRUD
List subnets
Get a list of subnets.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- Model Source:
CoreStates - Model Source:
OpenStackSubNetFieldEnum - API Source:
openstack_subnets_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
backend_id |
string | Backend ID |
can_manage |
boolean | Can manage |
customer |
string (uuid) | Customer UUID |
customer_abbreviation |
string | Customer abbreviation |
customer_name |
string | Customer name |
customer_native_name |
string | Customer native name |
customer_uuid |
string (uuid) | Customer UUID |
description |
string | Description |
direct_only |
boolean | Direct only |
enable_dhcp |
boolean | |
external_ip |
string | External IP |
field |
array | |
ip_version |
integer | |
name |
string | Name |
name_exact |
string | Name (exact) |
network |
string (uri) | Network URL |
network_uuid |
string (uuid) | Network UUID |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
project |
string (uuid) | Project UUID |
project_name |
string | Project name |
project_uuid |
string (uuid) | Project UUID |
rbac_only |
boolean | RBAC only |
service_settings_name |
string | Service settings name |
service_settings_uuid |
string (uuid) | Service settings UUID |
state |
array | State |
tenant |
string (uri) | Tenant URL |
tenant_uuid |
string (uuid) | Tenant UUID |
uuid |
string (uuid) | UUID |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
tenant |
string (uri) | |
tenant_name |
string | |
network |
string (uri) | Network to which this subnet belongs |
network_name |
string | |
cidr |
string | |
gateway_ip |
any | IP address of the gateway for this subnet |
disable_gateway |
boolean | If True, no gateway IP address will be allocated |
allocation_pools |
array of objects | |
allocation_pools.start |
any | An IPv4 or IPv6 address. |
allocation_pools.end |
any | An IPv4 or IPv6 address. |
ip_version |
integer | IP protocol version (4 or 6) |
enable_dhcp |
boolean | If True, DHCP service will be enabled on this subnet |
dns_nameservers |
array of anys | |
host_routes |
array of objects | |
host_routes.destination |
string | |
host_routes.nexthop |
any | An IPv4 or IPv6 address. |
is_connected |
boolean | Is subnet connected to the default tenant router. |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Get subnet details
Retrieve details of a specific subnet.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
OpenStackSubNetFieldEnum - API Source:
openstack_subnets_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
tenant |
string (uri) | |
tenant_name |
string | |
network |
string (uri) | Network to which this subnet belongs |
network_name |
string | |
cidr |
string | |
gateway_ip |
any | IP address of the gateway for this subnet |
disable_gateway |
boolean | If True, no gateway IP address will be allocated |
allocation_pools |
array of objects | |
allocation_pools.start |
any | An IPv4 or IPv6 address. |
allocation_pools.end |
any | An IPv4 or IPv6 address. |
ip_version |
integer | IP protocol version (4 or 6) |
enable_dhcp |
boolean | If True, DHCP service will be enabled on this subnet |
dns_nameservers |
array of anys | |
host_routes |
array of objects | |
host_routes.destination |
string | |
host_routes.nexthop |
any | An IPv4 or IPv6 address. |
is_connected |
boolean | Is subnet connected to the default tenant router. |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Synchronize resource state
Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_subnets_pull
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
202 -
| Field | Type |
|---|---|
detail |
string |
409 -
| Field | Type |
|---|---|
detail |
string |
Unlink resource
Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_subnets_unlink
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Update subnet
Update an existing subnet.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
OpenStackSubNetRequest - API Source:
openstack_subnets_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ✓ | |
description |
string | ||
cidr |
string | ||
gateway_ip |
any | IP address of the gateway for this subnet | |
disable_gateway |
boolean | If True, no gateway IP address will be allocated | |
allocation_pools |
array of objects | ||
allocation_pools.start |
any | ✓ | An IPv4 or IPv6 address. |
allocation_pools.end |
any | ✓ | An IPv4 or IPv6 address. |
dns_nameservers |
array of anys | ||
host_routes |
array of objects | ||
host_routes.destination |
string | ✓ | |
host_routes.nexthop |
any | ✓ | An IPv4 or IPv6 address. |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
tenant |
string (uri) | |
tenant_name |
string | |
network |
string (uri) | Network to which this subnet belongs |
network_name |
string | |
cidr |
string | |
gateway_ip |
any | IP address of the gateway for this subnet |
disable_gateway |
boolean | If True, no gateway IP address will be allocated |
allocation_pools |
array of objects | |
allocation_pools.start |
any | An IPv4 or IPv6 address. |
allocation_pools.end |
any | An IPv4 or IPv6 address. |
ip_version |
integer | IP protocol version (4 or 6) |
enable_dhcp |
boolean | If True, DHCP service will be enabled on this subnet |
dns_nameservers |
array of anys | |
host_routes |
array of objects | |
host_routes.destination |
string | |
host_routes.nexthop |
any | An IPv4 or IPv6 address. |
is_connected |
boolean | Is subnet connected to the default tenant router. |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Partially update subnet
Update specific fields of a subnet.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedOpenStackSubNetRequest - API Source:
openstack_subnets_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ||
description |
string | ||
cidr |
string | ||
gateway_ip |
any | IP address of the gateway for this subnet | |
disable_gateway |
boolean | If True, no gateway IP address will be allocated | |
allocation_pools |
array of objects | ||
allocation_pools.start |
any | ✓ | An IPv4 or IPv6 address. |
allocation_pools.end |
any | ✓ | An IPv4 or IPv6 address. |
dns_nameservers |
array of anys | ||
host_routes |
array of objects | ||
host_routes.destination |
string | ✓ | |
host_routes.nexthop |
any | ✓ | An IPv4 or IPv6 address. |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
tenant |
string (uri) | |
tenant_name |
string | |
network |
string (uri) | Network to which this subnet belongs |
network_name |
string | |
cidr |
string | |
gateway_ip |
any | IP address of the gateway for this subnet |
disable_gateway |
boolean | If True, no gateway IP address will be allocated |
allocation_pools |
array of objects | |
allocation_pools.start |
any | An IPv4 or IPv6 address. |
allocation_pools.end |
any | An IPv4 or IPv6 address. |
ip_version |
integer | IP protocol version (4 or 6) |
enable_dhcp |
boolean | If True, DHCP service will be enabled on this subnet |
dns_nameservers |
array of anys | |
host_routes |
array of objects | |
host_routes.destination |
string | |
host_routes.nexthop |
any | An IPv4 or IPv6 address. |
is_connected |
boolean | Is subnet connected to the default tenant router. |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Delete subnet
Delete a subnet.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_subnets_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
Connect subnet to router
Connect the subnet to the default tenant router.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_subnets_connect
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - No response body
Disconnect subnet from router
Disconnect the subnet from the default tenant router.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_subnets_disconnect
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - No response body
Mark resource as ERRED
Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
SetErredRequest - API Source:
openstack_subnets_set_erred
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
error_message |
string | |
error_traceback |
string |
200 -
| Field | Type |
|---|---|
detail |
string |
Mark resource as OK
Manually transition the resource to OK state and clear error fields. Staff-only operation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_subnets_set_ok
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
detail |
string |
Openstack Tenants
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/openstack-tenants/ |
List tenants |
| GET | /api/openstack-tenants/{uuid}/ |
Get tenant details |
| POST | /api/openstack-tenants/{uuid}/pull/ |
Synchronize resource state |
| POST | /api/openstack-tenants/{uuid}/unlink/ |
Unlink resource |
| PUT | /api/openstack-tenants/{uuid}/ |
Update tenant |
| PATCH | /api/openstack-tenants/{uuid}/ |
Partially update tenant |
| Configuration & Updates | ||
| POST | /api/openstack-tenants/{uuid}/change_password/ |
Change tenant user password |
| POST | /api/openstack-tenants/{uuid}/set_quotas/ |
Set tenant quotas |
| Sub-Resource Creation | ||
| POST | /api/openstack-tenants/{uuid}/create_floating_ip/ |
Create floating IP for tenant |
| POST | /api/openstack-tenants/{uuid}/create_network/ |
Create network for tenant |
| POST | /api/openstack-tenants/{uuid}/create_security_group/ |
Create security group |
| POST | /api/openstack-tenants/{uuid}/create_server_group/ |
Create server group |
| Data & Reporting | ||
| GET | /api/openstack-tenants/{uuid}/backend_instances/ |
List backend instances |
| GET | /api/openstack-tenants/{uuid}/backend_volumes/ |
List backend volumes |
| Remote Actions & Sync | ||
| POST | /api/openstack-tenants/{uuid}/pull_floating_ips/ |
Pull floating IPs |
| POST | /api/openstack-tenants/{uuid}/pull_quotas/ |
Pull tenant quotas |
| POST | /api/openstack-tenants/{uuid}/pull_security_groups/ |
Pull security groups |
| POST | /api/openstack-tenants/{uuid}/pull_server_groups/ |
Pull server groups |
| Other Actions | ||
| POST | /api/openstack-tenants/{uuid}/push_security_groups/ |
Batch update security groups for a tenant. |
| POST | /api/openstack-tenants/{uuid}/set_erred/ |
Mark resource as ERRED |
| POST | /api/openstack-tenants/{uuid}/set_ok/ |
Mark resource as OK |
Core CRUD
List tenants
Get a list of OpenStack tenants.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- Model Source:
CoreStates - Model Source:
OpenStackTenantFieldEnum - API Source:
openstack_tenants_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
backend_id |
string | Backend ID |
can_manage |
boolean | Can manage |
customer |
string (uuid) | Customer UUID |
customer_abbreviation |
string | Customer abbreviation |
customer_name |
string | Customer name |
customer_native_name |
string | Customer native name |
customer_uuid |
string (uuid) | Customer UUID |
description |
string | Description |
external_ip |
string | External IP |
field |
array | |
name |
string | Name |
name_exact |
string | Name (exact) |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
project |
string (uuid) | Project UUID |
project_name |
string | Project name |
project_uuid |
string (uuid) | Project UUID |
service_settings_name |
string | Service settings name |
service_settings_uuid |
string (uuid) | Service settings UUID |
state |
array | State |
uuid |
string (uuid) | UUID |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | ID of tenant in the OpenStack backend |
access_url |
string | |
availability_zone |
string | Optional availability group. Will be used for all instances provisioned in this tenant |
internal_network_id |
string | ID of internal network in OpenStack tenant |
external_network_id |
string | ID of external network connected to OpenStack tenant |
external_network_ref_uuid |
string (uuid) | |
external_network_ref_name |
string | |
user_username |
string | Username of the tenant user |
user_password |
string | Password of the tenant user |
quotas |
array of objects | |
quotas.name |
string | |
quotas.usage |
integer | |
quotas.limit |
integer | |
default_volume_type_name |
string | Volume type name to use when creating volumes. |
skip_creation_of_default_router |
boolean | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Get tenant details
Retrieve details of a specific OpenStack tenant.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
OpenStackTenantFieldEnum - API Source:
openstack_tenants_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | ID of tenant in the OpenStack backend |
access_url |
string | |
availability_zone |
string | Optional availability group. Will be used for all instances provisioned in this tenant |
internal_network_id |
string | ID of internal network in OpenStack tenant |
external_network_id |
string | ID of external network connected to OpenStack tenant |
external_network_ref_uuid |
string (uuid) | |
external_network_ref_name |
string | |
user_username |
string | Username of the tenant user |
user_password |
string | Password of the tenant user |
quotas |
array of objects | |
quotas.name |
string | |
quotas.usage |
integer | |
quotas.limit |
integer | |
default_volume_type_name |
string | Volume type name to use when creating volumes. |
skip_creation_of_default_router |
boolean | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Synchronize resource state
Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_tenants_pull
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
202 -
| Field | Type |
|---|---|
detail |
string |
409 -
| Field | Type |
|---|---|
detail |
string |
Unlink resource
Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_tenants_unlink
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Update tenant
Update an existing OpenStack tenant.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
OpenStackTenantRequest - API Source:
openstack_tenants_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ✓ | |
description |
string | ||
availability_zone |
string | Optional availability group. Will be used for all instances provisioned in this tenant | |
default_volume_type_name |
string | Volume type name to use when creating volumes. | |
security_groups |
array of objects | Constraints: write-only |
|
security_groups.name |
string | ✓ | |
security_groups.description |
string | ||
security_groups.rules |
array of objects | ||
security_groups.rules.ethertype |
any | IP protocol version - either 'IPv4' or 'IPv6' | |
security_groups.rules.direction |
any | Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing) | |
security_groups.rules.protocol |
any | The network protocol (TCP, UDP, ICMP, or empty for any protocol) | |
security_groups.rules.from_port |
integer | Starting port number in the range (1-65535) | |
security_groups.rules.to_port |
integer | Ending port number in the range (1-65535) | |
security_groups.rules.cidr |
string | CIDR notation for the source/destination network address range | |
security_groups.rules.description |
string | ||
security_groups.rules.remote_group |
string (uri) | Remote security group that this rule references, if any | |
skip_creation_of_default_subnet |
boolean | Constraints: write-only, default: False |
|
skip_creation_of_default_router |
boolean | Constraints: default: False |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | ID of tenant in the OpenStack backend |
access_url |
string | |
availability_zone |
string | Optional availability group. Will be used for all instances provisioned in this tenant |
internal_network_id |
string | ID of internal network in OpenStack tenant |
external_network_id |
string | ID of external network connected to OpenStack tenant |
external_network_ref_uuid |
string (uuid) | |
external_network_ref_name |
string | |
user_username |
string | Username of the tenant user |
user_password |
string | Password of the tenant user |
quotas |
array of objects | |
quotas.name |
string | |
quotas.usage |
integer | |
quotas.limit |
integer | |
default_volume_type_name |
string | Volume type name to use when creating volumes. |
skip_creation_of_default_router |
boolean | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Partially update tenant
Update specific fields of an OpenStack tenant.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedOpenStackTenantRequest - API Source:
openstack_tenants_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ||
description |
string | ||
availability_zone |
string | Optional availability group. Will be used for all instances provisioned in this tenant | |
default_volume_type_name |
string | Volume type name to use when creating volumes. | |
security_groups |
array of objects | Constraints: write-only |
|
security_groups.name |
string | ✓ | |
security_groups.description |
string | ||
security_groups.rules |
array of objects | ||
security_groups.rules.ethertype |
any | IP protocol version - either 'IPv4' or 'IPv6' | |
security_groups.rules.direction |
any | Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing) | |
security_groups.rules.protocol |
any | The network protocol (TCP, UDP, ICMP, or empty for any protocol) | |
security_groups.rules.from_port |
integer | Starting port number in the range (1-65535) | |
security_groups.rules.to_port |
integer | Ending port number in the range (1-65535) | |
security_groups.rules.cidr |
string | CIDR notation for the source/destination network address range | |
security_groups.rules.description |
string | ||
security_groups.rules.remote_group |
string (uri) | Remote security group that this rule references, if any | |
skip_creation_of_default_subnet |
boolean | Constraints: write-only, default: False |
|
skip_creation_of_default_router |
boolean | Constraints: default: False |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | ID of tenant in the OpenStack backend |
access_url |
string | |
availability_zone |
string | Optional availability group. Will be used for all instances provisioned in this tenant |
internal_network_id |
string | ID of internal network in OpenStack tenant |
external_network_id |
string | ID of external network connected to OpenStack tenant |
external_network_ref_uuid |
string (uuid) | |
external_network_ref_name |
string | |
user_username |
string | Username of the tenant user |
user_password |
string | Password of the tenant user |
quotas |
array of objects | |
quotas.name |
string | |
quotas.usage |
integer | |
quotas.limit |
integer | |
default_volume_type_name |
string | Volume type name to use when creating volumes. |
skip_creation_of_default_router |
boolean | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Configuration & Updates
Change tenant user password
Change password for tenant user
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
OpenStackTenantChangePasswordRequest - API Source:
openstack_tenants_change_password
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
user_password |
string | ✓ | New tenant user password. |
200 - No response body
Set tenant quotas
A quota can be set for a particular tenant. Only staff users and service provider owners/managers can do that.
In order to set quota submit POST request to /api/openstack-tenants/
The following quotas are supported. All values are expected to be integers:
- instances - maximal number of created instances.
- ram - maximal size of ram for allocation. In MiB_.
- storage - maximal size of storage for allocation. In MiB_.
- vcpu - maximal number of virtual cores for allocation.
- security_group_count - maximal number of created security groups.
- security_group_rule_count - maximal number of created security groups rules.
- volumes - maximal number of created volumes.
- snapshots - maximal number of created snapshots.
It is possible to update quotas by one or by submitting all the fields in one request. Waldur will attempt to update the provided quotas. Please note, that if provided quotas are conflicting with the backend (e.g. requested number of instances is below of the already existing ones), some quotas might not be applied.
.. _MiB: http://en.wikipedia.org/wiki/Mebibyte
Response code of a successful request is 202 ACCEPTED. In case tenant is in a non-stable status, the response would be 409 CONFLICT. In this case REST client is advised to repeat the request after some time. On successful completion the task will synchronize quotas with the backend.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
OpenStackTenantQuotaRequest - API Source:
openstack_tenants_set_quotas
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
instances |
integer | |
volumes |
integer | |
snapshots |
integer | |
ram |
integer | |
vcpu |
integer | |
storage |
integer | |
security_group_count |
integer | |
security_group_rule_count |
integer |
200 -
| Field | Type |
|---|---|
instances |
integer |
volumes |
integer |
snapshots |
integer |
ram |
integer |
vcpu |
integer |
storage |
integer |
security_group_count |
integer |
security_group_rule_count |
integer |
Sub-Resource Creation
Create floating IP for tenant
Create floating IP for tenant
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
OpenStackFloatingIPRequest - API Source:
openstack_tenants_create_floating_ip
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
router |
string (uri) | Optional router to use for external network detection Constraints: write-only |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
runtime_state |
string | |
address |
any | The public IPv4 address of the floating IP |
backend_network_id |
string | ID of network in OpenStack where this floating IP is allocated |
tenant |
string (uri) | OpenStack tenant this floating IP belongs to |
tenant_name |
string | |
tenant_uuid |
string (uuid) | |
port |
string (uri) | |
external_address |
any | Optional address that maps to floating IP's address in external networks |
port_fixed_ips |
array of objects | |
port_fixed_ips.ip_address |
any | IP address to assign to the port |
port_fixed_ips.subnet_id |
string | ID of the subnet in which to assign the IP address |
instance_uuid |
string | |
instance_name |
string | |
instance_url |
string | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Create network for tenant
Create network for tenant
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
OpenStackNetworkRequest - API Source:
openstack_tenants_create_network
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
name |
string | ✓ |
description |
string |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
tenant |
string (uri) | OpenStack tenant this network belongs to |
tenant_name |
string | |
tenant_uuid |
string (uuid) | |
is_external |
boolean | Defines whether this network is external (public) or internal (private) |
type |
string | Network type, such as local, flat, vlan, vxlan, or gre |
segmentation_id |
integer | VLAN ID for VLAN networks or tunnel ID for VXLAN/GRE networks |
subnets |
array of objects | |
subnets.uuid |
string (uuid) | |
subnets.name |
string | |
subnets.description |
string | |
subnets.cidr |
string | IPv4 network address in CIDR format (e.g. 192.168.0.0/24) |
subnets.gateway_ip |
any | IP address of the gateway for this subnet |
subnets.allocation_pools |
array of objects | |
subnets.allocation_pools.start |
any | An IPv4 or IPv6 address. |
subnets.allocation_pools.end |
any | An IPv4 or IPv6 address. |
subnets.ip_version |
integer | IP protocol version (4 or 6) |
subnets.enable_dhcp |
boolean | If True, DHCP service will be enabled on this subnet |
mtu |
integer | The maximum transmission unit (MTU) value to address fragmentation. |
rbac_policies |
array of objects | |
rbac_policies.url |
string (uri) | |
rbac_policies.uuid |
string (uuid) | |
rbac_policies.network |
string (uri) | |
rbac_policies.network_name |
string | |
rbac_policies.target_tenant |
string (uri) | |
rbac_policies.target_tenant_name |
string | |
rbac_policies.backend_id |
string | |
rbac_policies.policy_type |
any | Type of access granted - either shared access or external network access |
rbac_policies.created |
string (date-time) | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Create security group
Create a security group for the tenant.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
OpenStackSecurityGroupRequest - API Source:
openstack_tenants_create_security_group
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ✓ | |
description |
string | ||
rules |
array of objects | ✓ | |
rules.ethertype |
any | IP protocol version - either 'IPv4' or 'IPv6' | |
rules.direction |
any | Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing) | |
rules.protocol |
any | The network protocol (TCP, UDP, ICMP, or empty for any protocol) | |
rules.from_port |
integer | Starting port number in the range (1-65535) | |
rules.to_port |
integer | Ending port number in the range (1-65535) | |
rules.cidr |
string | CIDR notation for the source/destination network address range | |
rules.description |
string | ||
rules.remote_group |
string (uri) | Remote security group that this rule references, if any |
201 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
tenant |
string (uri) | |
tenant_name |
string | |
tenant_uuid |
string (uuid) | |
rules |
array of objects | |
rules.ethertype |
any | IP protocol version - either 'IPv4' or 'IPv6' |
rules.direction |
any | Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing) |
rules.protocol |
any | The network protocol (TCP, UDP, ICMP, or empty for any protocol) |
rules.from_port |
integer | Starting port number in the range (1-65535) |
rules.to_port |
integer | Ending port number in the range (1-65535) |
rules.cidr |
string | CIDR notation for the source/destination network address range |
rules.description |
string | |
rules.remote_group_name |
string | |
rules.remote_group_uuid |
string (uuid) | |
rules.id |
integer | |
rules.remote_group |
string (uri) | Remote security group that this rule references, if any |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Create server group
Create a new server group for the tenant.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
OpenStackServerGroupRequest - API Source:
openstack_tenants_create_server_group
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ✓ | |
description |
string | ||
policy |
any | affinity — all instances are placed on the same hypervisor. anti-affinity — all instances are placed on different hypervisors. soft-affinity — instances are placed on the same hypervisor if possible, but not enforced. soft-anti-affinity — instances are placed on different hypervisors if possible, but not enforced. |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
tenant |
string (uri) | |
tenant_name |
string | |
tenant_uuid |
string (uuid) | |
policy |
any | affinity — all instances are placed on the same hypervisor. anti-affinity — all instances are placed on different hypervisors. soft-affinity — instances are placed on the same hypervisor if possible, but not enforced. soft-anti-affinity — instances are placed on different hypervisors if possible, but not enforced. |
display_name |
string | |
instances |
array of objects | |
instances.backend_id |
string | Instance ID in the OpenStack backend |
instances.name |
string | |
instances.uuid |
string (uuid) | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Data & Reporting
List backend instances
Return a list of volumes from backend
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
- Model Source:
CoreStates - API Source:
openstack_tenants_backend_instances_list
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
backend_id |
string | Backend ID |
can_manage |
boolean | Can manage |
customer |
string (uuid) | Customer UUID |
customer_abbreviation |
string | Customer abbreviation |
customer_name |
string | Customer name |
customer_native_name |
string | Customer native name |
customer_uuid |
string (uuid) | Customer UUID |
description |
string | Description |
external_ip |
string | External IP |
name |
string | Name |
name_exact |
string | Name (exact) |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
project |
string (uuid) | Project UUID |
project_name |
string | Project name |
project_uuid |
string (uuid) | Project UUID |
service_settings_name |
string | Service settings name |
service_settings_uuid |
string (uuid) | Service settings UUID |
state |
array | State |
uuid |
string (uuid) | UUID |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
name |
string | |
key_name |
string | |
start_time |
string (date-time) | |
state |
string | |
runtime_state |
string | |
created |
string (date-time) | |
backend_id |
string | Instance ID in the OpenStack backend |
availability_zone |
string | |
hypervisor_hostname |
string | Name of the hypervisor hosting this instance |
List backend volumes
Return a list of volumes from backend
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
- Model Source:
CoreStates - API Source:
openstack_tenants_backend_volumes_list
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
backend_id |
string | Backend ID |
can_manage |
boolean | Can manage |
customer |
string (uuid) | Customer UUID |
customer_abbreviation |
string | Customer abbreviation |
customer_name |
string | Customer name |
customer_native_name |
string | Customer native name |
customer_uuid |
string (uuid) | Customer UUID |
description |
string | Description |
external_ip |
string | External IP |
name |
string | Name |
name_exact |
string | Name (exact) |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
project |
string (uuid) | Project UUID |
project_name |
string | Project name |
project_uuid |
string (uuid) | Project UUID |
service_settings_name |
string | Service settings name |
service_settings_uuid |
string (uuid) | Service settings UUID |
state |
array | State |
uuid |
string (uuid) | UUID |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
name |
string | |
description |
string | |
size |
integer | Size in MiB |
metadata |
string | Arbitrary key-value pairs associated with the volume |
backend_id |
string | Volume ID in the OpenStack backend |
type |
string | |
bootable |
boolean | Indicates if this volume can be used to boot an instance |
runtime_state |
string | |
state |
string | |
availability_zone |
string |
Remote Actions & Sync
Pull floating IPs
Trigger job to pull floating IPs from remote VPC
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_tenants_pull_floating_ips
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
202 - No response body
Pull tenant quotas
It triggers celery job to pull quotas from remote VPC
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_tenants_pull_quotas
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - No response body
Pull security groups
Trigger job to pull security groups from remote VPC
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_tenants_pull_security_groups
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | ID of tenant in the OpenStack backend |
access_url |
string | |
availability_zone |
string | Optional availability group. Will be used for all instances provisioned in this tenant |
internal_network_id |
string | ID of internal network in OpenStack tenant |
external_network_id |
string | ID of external network connected to OpenStack tenant |
external_network_ref_uuid |
string (uuid) | |
external_network_ref_name |
string | |
user_username |
string | Username of the tenant user |
user_password |
string | Password of the tenant user |
quotas |
array of objects | |
quotas.name |
string | |
quotas.usage |
integer | |
quotas.limit |
integer | |
default_volume_type_name |
string | Volume type name to use when creating volumes. |
skip_creation_of_default_router |
boolean | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Pull server groups
Trigger job to pull server groups from remote VPC
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_tenants_pull_server_groups
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | ID of tenant in the OpenStack backend |
access_url |
string | |
availability_zone |
string | Optional availability group. Will be used for all instances provisioned in this tenant |
internal_network_id |
string | ID of internal network in OpenStack tenant |
external_network_id |
string | ID of external network connected to OpenStack tenant |
external_network_ref_uuid |
string (uuid) | |
external_network_ref_name |
string | |
user_username |
string | Username of the tenant user |
user_password |
string | Password of the tenant user |
quotas |
array of objects | |
quotas.name |
string | |
quotas.usage |
integer | |
quotas.limit |
integer | |
default_volume_type_name |
string | Volume type name to use when creating volumes. |
skip_creation_of_default_router |
boolean | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Other Actions
Batch update security groups for a tenant.
1 2 3 4 5 6 | |
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_tenants_push_security_groups
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
The request body is an array of objects, where each object has the following structure:
| Field | Type | Required | Description |
|---|---|---|---|
uuid |
string (uuid) | ||
name |
string | ✓ | |
description |
string | ||
rules |
array of objects | ||
rules.ethertype |
any | IP protocol version - either 'IPv4' or 'IPv6' | |
rules.direction |
any | Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing) | |
rules.protocol |
any | The network protocol (TCP, UDP, ICMP, or empty for any protocol) | |
rules.from_port |
integer | Starting port number in the range (1-65535) | |
rules.to_port |
integer | Ending port number in the range (1-65535) | |
rules.cidr |
string | CIDR notation for the source/destination network address range | |
rules.description |
string | ||
rules.remote_group_name |
string | Constraints: write-only |
|
rules.remote_group |
string (uri) |
200 - No response body
Mark resource as ERRED
Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
SetErredRequest - API Source:
openstack_tenants_set_erred
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
error_message |
string | |
error_traceback |
string |
200 -
| Field | Type |
|---|---|
detail |
string |
Mark resource as OK
Manually transition the resource to OK state and clear error fields. Staff-only operation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_tenants_set_ok
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
detail |
string |
Openstack Volume Availability Zones
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/openstack-volume-availability-zones/ |
List volume availability zones |
| GET | /api/openstack-volume-availability-zones/{uuid}/ |
Get volume availability zone details |
List volume availability zones
Get a list of volume availability zones.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
openstack_volume_availability_zones_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
name |
string | Name |
name_exact |
string | Name (exact) |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
settings |
string (uri) | Settings URL |
settings_uuid |
string (uuid) | Settings UUID |
tenant |
string (uri) | Tenant URL |
tenant_uuid |
string (uuid) | Tenant UUID |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
settings |
string (uri) |
available |
boolean |
Get volume availability zone details
Retrieve details of a specific volume availability zone.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_volume_availability_zones_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
settings |
string (uri) |
available |
boolean |
Openstack Volume Types
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/openstack-volume-types/ |
List volume types |
| GET | /api/openstack-volume-types/{uuid}/ |
Get volume type details |
| Other Actions | ||
| GET | /api/openstack-volume-types/names/ |
List unique volume type names |
Core CRUD
List volume types
Get a list of available volume types.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
openstack_volume_types_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
name |
string | Name |
name_exact |
string | Name (exact) |
offering_uuid |
string (uuid) | Offering UUID |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
settings |
string (uri) | Settings URL |
settings_uuid |
string (uuid) | Settings UUID |
tenant |
string (uri) | Tenant URL |
tenant_uuid |
string (uuid) | Tenant UUID |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
description |
string |
settings |
string (uri) |
Get volume type details
Retrieve details of a specific volume type.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_volume_types_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
description |
string |
settings |
string (uri) |
Other Actions
List unique volume type names
Return a list of unique volume type names.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
openstack_volume_types_names_retrieve
1 2 3 4 5 6 7 8 9 10 | |
200 -
Openstack Volumes
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/openstack-volumes/ |
List volumes |
| GET | /api/openstack-volumes/{uuid}/ |
Get volume details |
| POST | /api/openstack-volumes/{uuid}/pull/ |
Synchronize resource state |
| POST | /api/openstack-volumes/{uuid}/unlink/ |
Unlink resource |
| PUT | /api/openstack-volumes/{uuid}/ |
Update volume |
| PATCH | /api/openstack-volumes/{uuid}/ |
Partially update volume |
| Other Actions | ||
| POST | /api/openstack-volumes/{uuid}/attach/ |
Attach volume to instance |
| POST | /api/openstack-volumes/{uuid}/detach/ |
Detach volume from instance |
| POST | /api/openstack-volumes/{uuid}/extend/ |
Extend volume size |
| POST | /api/openstack-volumes/{uuid}/retype/ |
Change volume type |
| POST | /api/openstack-volumes/{uuid}/set_erred/ |
Mark resource as ERRED |
| POST | /api/openstack-volumes/{uuid}/set_ok/ |
Mark resource as OK |
| POST | /api/openstack-volumes/{uuid}/snapshot/ |
Create volume snapshot |
Core CRUD
List volumes
Get a list of volumes.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- Model Source:
CoreStates - Model Source:
OpenStackVolumeFieldEnum - API Source:
openstack_volumes_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
attach_instance_uuid |
string (uuid) | Filter for attachment to instance UUID |
availability_zone_name |
string | Availability zone name |
backend_id |
string | Backend ID |
can_manage |
boolean | Can manage |
customer |
string (uuid) | Customer UUID |
customer_abbreviation |
string | Customer abbreviation |
customer_name |
string | Customer name |
customer_native_name |
string | Customer native name |
customer_uuid |
string (uuid) | Customer UUID |
description |
string | Description |
external_ip |
string | External IP |
field |
array | |
instance |
string (uri) | Instance URL |
instance_uuid |
string (uuid) | Instance UUID |
name |
string | Name |
name_exact |
string | Name (exact) |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
project |
string (uuid) | Project UUID |
project_name |
string | Project name |
project_uuid |
string (uuid) | Project UUID |
runtime_state |
string | |
service_settings_name |
string | Service settings name |
service_settings_uuid |
string (uuid) | Service settings UUID |
snapshot |
string (uri) | Snapshot URL |
snapshot_uuid |
string (uuid) | Snapshot UUID |
state |
array | State |
tenant |
string (uri) | Tenant URL |
tenant_uuid |
string (uuid) | Tenant UUID |
uuid |
string (uuid) | UUID |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | Volume ID in the OpenStack backend |
access_url |
string | |
source_snapshot |
string (uri) | Snapshot that this volume was created from, if any |
size |
integer | Size in MiB |
bootable |
boolean | Indicates if this volume can be used to boot an instance |
metadata |
any | |
image |
string (uri) | Image that this volume was created from, if any |
image_metadata |
string | Metadata of the image this volume was created from |
image_name |
string | Name of the image this volume was created from |
type |
string (uri) | Type of the volume (e.g. SSD, HDD) |
type_name |
string | |
runtime_state |
string | |
availability_zone |
string (uri) | Availability zone where this volume is located |
availability_zone_name |
string | |
device |
string | Name of volume as instance device e.g. /dev/vdb. |
action |
string | |
action_details |
any | |
instance |
string (uri) | Instance that this volume is attached to, if any |
instance_name |
string | |
instance_marketplace_uuid |
string (uuid) | |
tenant |
string (uri) | |
tenant_uuid |
string (uuid) | |
extend_enabled |
boolean | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Get volume details
Retrieve details of a specific volume.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
OpenStackVolumeFieldEnum - API Source:
openstack_volumes_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | Volume ID in the OpenStack backend |
access_url |
string | |
source_snapshot |
string (uri) | Snapshot that this volume was created from, if any |
size |
integer | Size in MiB |
bootable |
boolean | Indicates if this volume can be used to boot an instance |
metadata |
any | |
image |
string (uri) | Image that this volume was created from, if any |
image_metadata |
string | Metadata of the image this volume was created from |
image_name |
string | Name of the image this volume was created from |
type |
string (uri) | Type of the volume (e.g. SSD, HDD) |
type_name |
string | |
runtime_state |
string | |
availability_zone |
string (uri) | Availability zone where this volume is located |
availability_zone_name |
string | |
device |
string | Name of volume as instance device e.g. /dev/vdb. |
action |
string | |
action_details |
any | |
instance |
string (uri) | Instance that this volume is attached to, if any |
instance_name |
string | |
instance_marketplace_uuid |
string (uuid) | |
tenant |
string (uri) | |
tenant_uuid |
string (uuid) | |
extend_enabled |
boolean | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Synchronize resource state
Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_volumes_pull
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
202 -
| Field | Type |
|---|---|
detail |
string |
409 -
| Field | Type |
|---|---|
detail |
string |
Unlink resource
Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_volumes_unlink
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Update volume
Update an existing volume.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
OpenStackVolumeRequest - API Source:
openstack_volumes_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ✓ | |
description |
string | ||
bootable |
boolean | Indicates if this volume can be used to boot an instance |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | Volume ID in the OpenStack backend |
access_url |
string | |
source_snapshot |
string (uri) | Snapshot that this volume was created from, if any |
size |
integer | Size in MiB |
bootable |
boolean | Indicates if this volume can be used to boot an instance |
metadata |
any | |
image |
string (uri) | Image that this volume was created from, if any |
image_metadata |
string | Metadata of the image this volume was created from |
image_name |
string | Name of the image this volume was created from |
type |
string (uri) | Type of the volume (e.g. SSD, HDD) |
type_name |
string | |
runtime_state |
string | |
availability_zone |
string (uri) | Availability zone where this volume is located |
availability_zone_name |
string | |
device |
string | Name of volume as instance device e.g. /dev/vdb. |
action |
string | |
action_details |
any | |
instance |
string (uri) | Instance that this volume is attached to, if any |
instance_name |
string | |
instance_marketplace_uuid |
string (uuid) | |
tenant |
string (uri) | |
tenant_uuid |
string (uuid) | |
extend_enabled |
boolean | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Partially update volume
Update specific fields of a volume.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedOpenStackVolumeRequest - API Source:
openstack_volumes_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ||
description |
string | ||
bootable |
boolean | Indicates if this volume can be used to boot an instance |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | Volume ID in the OpenStack backend |
access_url |
string | |
source_snapshot |
string (uri) | Snapshot that this volume was created from, if any |
size |
integer | Size in MiB |
bootable |
boolean | Indicates if this volume can be used to boot an instance |
metadata |
any | |
image |
string (uri) | Image that this volume was created from, if any |
image_metadata |
string | Metadata of the image this volume was created from |
image_name |
string | Name of the image this volume was created from |
type |
string (uri) | Type of the volume (e.g. SSD, HDD) |
type_name |
string | |
runtime_state |
string | |
availability_zone |
string (uri) | Availability zone where this volume is located |
availability_zone_name |
string | |
device |
string | Name of volume as instance device e.g. /dev/vdb. |
action |
string | |
action_details |
any | |
instance |
string (uri) | Instance that this volume is attached to, if any |
instance_name |
string | |
instance_marketplace_uuid |
string (uuid) | |
tenant |
string (uri) | |
tenant_uuid |
string (uuid) | |
extend_enabled |
boolean | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Other Actions
Attach volume to instance
Attach volume to instance
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
VolumeAttachRequest - API Source:
openstack_volumes_attach
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
instance |
string (uri) | ✓ | Instance that this volume is attached to, if any |
200 - No response body
Detach volume from instance
Detach instance from volume
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_volumes_detach
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - No response body
Extend volume size
Increase volume size
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
OpenStackVolumeExtendRequest - API Source:
openstack_volumes_extend
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
disk_size |
integer | ✓ |
200 - No response body
Change volume type
Retype detached volume
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
OpenStackVolumeRetypeRequest - API Source:
openstack_volumes_retype
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
type |
string (uri) | ✓ |
200 - No response body
Mark resource as ERRED
Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
SetErredRequest - API Source:
openstack_volumes_set_erred
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
error_message |
string | |
error_traceback |
string |
200 -
| Field | Type |
|---|---|
detail |
string |
Mark resource as OK
Manually transition the resource to OK state and clear error fields. Staff-only operation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
openstack_volumes_set_ok
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
detail |
string |
Create volume snapshot
Create snapshot from volume
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
OpenStackSnapshotRequest - API Source:
openstack_volumes_snapshot
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ✓ | |
description |
string | ||
metadata |
any | ||
kept_until |
string (date-time) | Guaranteed time of snapshot retention. If null - keep forever. |
201 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | Snapshot ID in the OpenStack backend |
access_url |
string | |
source_volume |
string (uri) | Volume from which this snapshot was created |
size |
integer | Size in MiB |
metadata |
any | |
runtime_state |
string | |
source_volume_name |
string | |
source_volume_marketplace_uuid |
string (uuid) | |
action |
string | |
action_details |
any | |
restorations |
array of objects | |
restorations.uuid |
string (uuid) | |
restorations.created |
string (date-time) | |
restorations.description |
string | New volume description. |
restorations.volume |
string (uri) | Volume that is being restored from the snapshot |
restorations.volume_name |
string | |
restorations.volume_state |
string | |
restorations.volume_runtime_state |
string | |
restorations.volume_size |
integer | Size in MiB |
restorations.volume_device |
string | Name of volume as instance device e.g. /dev/vdb. |
kept_until |
string (date-time) | Guaranteed time of snapshot retention. If null - keep forever. |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Rancher
Rancher Apps
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/rancher-apps/ |
List Rancher Apps |
| GET | /api/rancher-apps/{uuid}/ |
Retrieve |
| POST | /api/rancher-apps/ |
Create |
| POST | /api/rancher-apps/{uuid}/pull/ |
Synchronize resource state |
| POST | /api/rancher-apps/{uuid}/unlink/ |
Unlink resource |
| PUT | /api/rancher-apps/{uuid}/ |
Update |
| PATCH | /api/rancher-apps/{uuid}/ |
Partial Update |
| DELETE | /api/rancher-apps/{uuid}/ |
Delete |
| Other Actions | ||
| POST | /api/rancher-apps/{uuid}/set_erred/ |
Mark resource as ERRED |
| POST | /api/rancher-apps/{uuid}/set_ok/ |
Mark resource as OK |
Core CRUD
List Rancher Apps
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- Model Source:
CoreStates - Model Source:
RancherApplicationFieldEnum - API Source:
rancher_apps_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
backend_id |
string | Backend ID |
can_manage |
boolean | Can manage |
cluster_uuid |
string (uuid) | |
customer |
string (uuid) | Customer UUID |
customer_abbreviation |
string | Customer abbreviation |
customer_name |
string | Customer name |
customer_native_name |
string | Customer native name |
customer_uuid |
string (uuid) | Customer UUID |
description |
string | Description |
external_ip |
string | External IP |
field |
array | |
name |
string | Name |
name_exact |
string | Name (exact) |
namespace_uuid |
string (uuid) | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
project |
string (uuid) | Project UUID |
project_name |
string | Project name |
project_uuid |
string (uuid) | |
service_settings_name |
string | Service settings name |
service_settings_uuid |
string (uuid) | Service settings UUID |
state |
array | State |
template_uuid |
string (uuid) | |
uuid |
string (uuid) | UUID |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
description |
string |
service_name |
string |
service_settings |
string (uri) |
service_settings_uuid |
string (uuid) |
service_settings_state |
string |
service_settings_error_message |
string |
project |
string (uri) |
project_name |
string |
project_uuid |
string (uuid) |
customer |
string (uri) |
customer_uuid |
string (uuid) |
customer_name |
string |
customer_native_name |
string |
customer_abbreviation |
string |
error_message |
string |
error_traceback |
string |
resource_type |
string |
state |
any |
created |
string (date-time) |
modified |
string (date-time) |
backend_id |
string |
access_url |
string |
runtime_state |
string |
template |
string (uri) |
rancher_project |
string (uri) |
namespace |
string (uri) |
version |
string |
answers |
object (free-form) |
rancher_project_name |
string |
catalog_name |
string |
template_name |
string |
external_url |
string |
marketplace_offering_uuid |
string |
marketplace_offering_name |
string |
marketplace_offering_plugin_options |
object (free-form) |
marketplace_category_uuid |
string |
marketplace_category_name |
string |
marketplace_resource_uuid |
string |
marketplace_plan_uuid |
string |
marketplace_resource_state |
string |
is_usage_based |
boolean |
is_limit_based |
boolean |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
RancherApplicationFieldEnum - API Source:
rancher_apps_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
description |
string |
service_name |
string |
service_settings |
string (uri) |
service_settings_uuid |
string (uuid) |
service_settings_state |
string |
service_settings_error_message |
string |
project |
string (uri) |
project_name |
string |
project_uuid |
string (uuid) |
customer |
string (uri) |
customer_uuid |
string (uuid) |
customer_name |
string |
customer_native_name |
string |
customer_abbreviation |
string |
error_message |
string |
error_traceback |
string |
resource_type |
string |
state |
any |
created |
string (date-time) |
modified |
string (date-time) |
backend_id |
string |
access_url |
string |
runtime_state |
string |
template |
string (uri) |
rancher_project |
string (uri) |
namespace |
string (uri) |
version |
string |
answers |
object (free-form) |
rancher_project_name |
string |
catalog_name |
string |
template_name |
string |
external_url |
string |
marketplace_offering_uuid |
string |
marketplace_offering_name |
string |
marketplace_offering_plugin_options |
object (free-form) |
marketplace_category_uuid |
string |
marketplace_category_name |
string |
marketplace_resource_uuid |
string |
marketplace_plan_uuid |
string |
marketplace_resource_state |
string |
is_usage_based |
boolean |
is_limit_based |
boolean |
Create
1 2 3 4 5 6 7 8 9 10 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 | |
- Model Source:
RancherApplicationRequest - API Source:
rancher_apps_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
| Field | Type | Required |
|---|---|---|
name |
string | ✓ |
description |
string | |
service_settings |
string (uri) | ✓ |
project |
string (uri) | ✓ |
error_message |
string | |
error_traceback |
string | |
backend_id |
string | |
runtime_state |
string | |
template |
string (uri) | ✓ |
rancher_project |
string (uri) | ✓ |
namespace |
string (uri) | |
namespace_name |
string | |
version |
string | ✓ |
answers |
object (free-form) |
201 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
description |
string |
service_name |
string |
service_settings |
string (uri) |
service_settings_uuid |
string (uuid) |
service_settings_state |
string |
service_settings_error_message |
string |
project |
string (uri) |
project_name |
string |
project_uuid |
string (uuid) |
customer |
string (uri) |
customer_uuid |
string (uuid) |
customer_name |
string |
customer_native_name |
string |
customer_abbreviation |
string |
error_message |
string |
error_traceback |
string |
resource_type |
string |
state |
any |
created |
string (date-time) |
modified |
string (date-time) |
backend_id |
string |
access_url |
string |
runtime_state |
string |
template |
string (uri) |
rancher_project |
string (uri) |
namespace |
string (uri) |
version |
string |
answers |
object (free-form) |
rancher_project_name |
string |
catalog_name |
string |
template_name |
string |
external_url |
string |
marketplace_offering_uuid |
string |
marketplace_offering_name |
string |
marketplace_offering_plugin_options |
object (free-form) |
marketplace_category_uuid |
string |
marketplace_category_name |
string |
marketplace_resource_uuid |
string |
marketplace_plan_uuid |
string |
marketplace_resource_state |
string |
is_usage_based |
boolean |
is_limit_based |
boolean |
Synchronize resource state
Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
rancher_apps_pull
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
202 -
| Field | Type |
|---|---|
detail |
string |
409 -
| Field | Type |
|---|---|
detail |
string |
Unlink resource
Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
rancher_apps_unlink
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Update
1 2 3 4 5 6 7 8 9 10 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 | |
- Model Source:
RancherApplicationRequest - API Source:
rancher_apps_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
name |
string | ✓ |
description |
string | |
service_settings |
string (uri) | ✓ |
project |
string (uri) | ✓ |
error_message |
string | |
error_traceback |
string | |
backend_id |
string | |
runtime_state |
string | |
template |
string (uri) | ✓ |
rancher_project |
string (uri) | ✓ |
namespace |
string (uri) | |
namespace_name |
string | |
version |
string | ✓ |
answers |
object (free-form) |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
description |
string |
service_name |
string |
service_settings |
string (uri) |
service_settings_uuid |
string (uuid) |
service_settings_state |
string |
service_settings_error_message |
string |
project |
string (uri) |
project_name |
string |
project_uuid |
string (uuid) |
customer |
string (uri) |
customer_uuid |
string (uuid) |
customer_name |
string |
customer_native_name |
string |
customer_abbreviation |
string |
error_message |
string |
error_traceback |
string |
resource_type |
string |
state |
any |
created |
string (date-time) |
modified |
string (date-time) |
backend_id |
string |
access_url |
string |
runtime_state |
string |
template |
string (uri) |
rancher_project |
string (uri) |
namespace |
string (uri) |
version |
string |
answers |
object (free-form) |
rancher_project_name |
string |
catalog_name |
string |
template_name |
string |
external_url |
string |
marketplace_offering_uuid |
string |
marketplace_offering_name |
string |
marketplace_offering_plugin_options |
object (free-form) |
marketplace_category_uuid |
string |
marketplace_category_name |
string |
marketplace_resource_uuid |
string |
marketplace_plan_uuid |
string |
marketplace_resource_state |
string |
is_usage_based |
boolean |
is_limit_based |
boolean |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedRancherApplicationRequest - API Source:
rancher_apps_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
name |
string | |
description |
string | |
service_settings |
string (uri) | |
project |
string (uri) | |
error_message |
string | |
error_traceback |
string | |
backend_id |
string | |
runtime_state |
string | |
template |
string (uri) | |
rancher_project |
string (uri) | |
namespace |
string (uri) | |
namespace_name |
string | |
version |
string | |
answers |
object (free-form) |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
description |
string |
service_name |
string |
service_settings |
string (uri) |
service_settings_uuid |
string (uuid) |
service_settings_state |
string |
service_settings_error_message |
string |
project |
string (uri) |
project_name |
string |
project_uuid |
string (uuid) |
customer |
string (uri) |
customer_uuid |
string (uuid) |
customer_name |
string |
customer_native_name |
string |
customer_abbreviation |
string |
error_message |
string |
error_traceback |
string |
resource_type |
string |
state |
any |
created |
string (date-time) |
modified |
string (date-time) |
backend_id |
string |
access_url |
string |
runtime_state |
string |
template |
string (uri) |
rancher_project |
string (uri) |
namespace |
string (uri) |
version |
string |
answers |
object (free-form) |
rancher_project_name |
string |
catalog_name |
string |
template_name |
string |
external_url |
string |
marketplace_offering_uuid |
string |
marketplace_offering_name |
string |
marketplace_offering_plugin_options |
object (free-form) |
marketplace_category_uuid |
string |
marketplace_category_name |
string |
marketplace_resource_uuid |
string |
marketplace_plan_uuid |
string |
marketplace_resource_state |
string |
is_usage_based |
boolean |
is_limit_based |
boolean |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
rancher_apps_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
Mark resource as ERRED
Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
SetErredRequest - API Source:
rancher_apps_set_erred
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
error_message |
string | |
error_traceback |
string |
200 -
| Field | Type |
|---|---|
detail |
string |
Mark resource as OK
Manually transition the resource to OK state and clear error fields. Staff-only operation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
rancher_apps_set_ok
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
detail |
string |
Rancher Catalogs
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/rancher-catalogs/ |
List Rancher Catalogs |
| GET | /api/rancher-catalogs/{uuid}/ |
Retrieve |
| POST | /api/rancher-catalogs/ |
Create |
| PUT | /api/rancher-catalogs/{uuid}/ |
Update |
| PATCH | /api/rancher-catalogs/{uuid}/ |
Partial Update |
| DELETE | /api/rancher-catalogs/{uuid}/ |
Delete |
| Other Actions | ||
| POST | /api/rancher-catalogs/{uuid}/refresh/ |
Refresh |
Core CRUD
List Rancher Catalogs
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
rancher_catalogs_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
uuid |
string (uuid) |
url |
string (uri) |
created |
string (date-time) |
modified |
string (date-time) |
name |
string |
description |
string |
catalog_url |
string (uri) |
branch |
string |
commit |
string |
runtime_state |
string |
scope |
string |
scope_type |
any |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
rancher_catalogs_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
url |
string (uri) |
created |
string (date-time) |
modified |
string (date-time) |
name |
string |
description |
string |
catalog_url |
string (uri) |
branch |
string |
commit |
string |
runtime_state |
string |
scope |
string |
scope_type |
any |
Create
1 2 3 4 5 6 7 8 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | |
- Model Source:
RancherCatalogCreateRequest - API Source:
rancher_catalogs_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Field | Type | Required |
|---|---|---|
name |
string | ✓ |
description |
string | |
catalog_url |
string (uri) | ✓ |
branch |
string | ✓ |
scope |
string | ✓ |
username |
string | |
password |
string |
201 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
url |
string (uri) |
created |
string (date-time) |
modified |
string (date-time) |
name |
string |
description |
string |
catalog_url |
string (uri) |
branch |
string |
commit |
string |
runtime_state |
string |
scope |
string |
scope_type |
any |
username |
string |
password |
string |
Update
1 2 3 4 5 6 7 8 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 | |
- Model Source:
RancherCatalogUpdateRequest - API Source:
rancher_catalogs_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
name |
string | ✓ |
description |
string | |
catalog_url |
string (uri) | ✓ |
branch |
string | ✓ |
scope |
string | ✓ |
200 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
url |
string (uri) |
created |
string (date-time) |
modified |
string (date-time) |
name |
string |
description |
string |
catalog_url |
string (uri) |
branch |
string |
commit |
string |
runtime_state |
string |
scope |
string |
scope_type |
any |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedRancherCatalogRequest - API Source:
rancher_catalogs_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
name |
string | |
description |
string | |
catalog_url |
string (uri) | |
branch |
string | |
scope |
string |
200 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
url |
string (uri) |
created |
string (date-time) |
modified |
string (date-time) |
name |
string |
description |
string |
catalog_url |
string (uri) |
branch |
string |
commit |
string |
runtime_state |
string |
scope |
string |
scope_type |
any |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
rancher_catalogs_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
Refresh
1 2 3 4 5 6 7 8 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 | |
- Model Source:
RancherCatalogRequest - API Source:
rancher_catalogs_refresh
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
name |
string | ✓ |
description |
string | |
catalog_url |
string (uri) | ✓ |
branch |
string | ✓ |
scope |
string | ✓ |
200 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
url |
string (uri) |
created |
string (date-time) |
modified |
string (date-time) |
name |
string |
description |
string |
catalog_url |
string (uri) |
branch |
string |
commit |
string |
runtime_state |
string |
scope |
string |
scope_type |
any |
Rancher Cluster Security Groups
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/rancher-cluster-security-groups/ |
List Rancher Cluster Security Groups |
| GET | /api/rancher-cluster-security-groups/{uuid}/ |
Retrieve |
| PUT | /api/rancher-cluster-security-groups/{uuid}/ |
Update |
| PATCH | /api/rancher-cluster-security-groups/{uuid}/ |
Partial Update |
List Rancher Cluster Security Groups
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
rancher_cluster_security_groups_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
cluster_uuid |
string (uuid) | |
name |
string | Name |
name_exact |
string | Name (exact) |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
name |
string | |
description |
string | |
rules |
array of objects | |
rules.uuid |
string (uuid) | |
rules.ethertype |
any | IP protocol version - either 'IPv4' or 'IPv6' |
rules.direction |
any | Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing) |
rules.protocol |
any | The network protocol (TCP, UDP, ICMP, or empty for any protocol) |
rules.from_port |
integer | Starting port number in the range (1-65535) |
rules.to_port |
integer | Ending port number in the range (1-65535) |
rules.cidr |
string | CIDR notation for the source/destination network address range |
rules.description |
string |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
rancher_cluster_security_groups_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
name |
string | |
description |
string | |
rules |
array of objects | |
rules.uuid |
string (uuid) | |
rules.ethertype |
any | IP protocol version - either 'IPv4' or 'IPv6' |
rules.direction |
any | Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing) |
rules.protocol |
any | The network protocol (TCP, UDP, ICMP, or empty for any protocol) |
rules.from_port |
integer | Starting port number in the range (1-65535) |
rules.to_port |
integer | Ending port number in the range (1-65535) |
rules.cidr |
string | CIDR notation for the source/destination network address range |
rules.description |
string |
Update
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
ClusterSecurityGroupRequest - API Source:
rancher_cluster_security_groups_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
rules |
array of objects | ✓ | |
rules.ethertype |
any | IP protocol version - either 'IPv4' or 'IPv6' | |
rules.direction |
any | Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing) | |
rules.protocol |
any | The network protocol (TCP, UDP, ICMP, or empty for any protocol) | |
rules.from_port |
integer | Starting port number in the range (1-65535) | |
rules.to_port |
integer | Ending port number in the range (1-65535) | |
rules.cidr |
string | CIDR notation for the source/destination network address range | |
rules.description |
string |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
name |
string | |
description |
string | |
rules |
array of objects | |
rules.uuid |
string (uuid) | |
rules.ethertype |
any | IP protocol version - either 'IPv4' or 'IPv6' |
rules.direction |
any | Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing) |
rules.protocol |
any | The network protocol (TCP, UDP, ICMP, or empty for any protocol) |
rules.from_port |
integer | Starting port number in the range (1-65535) |
rules.to_port |
integer | Ending port number in the range (1-65535) |
rules.cidr |
string | CIDR notation for the source/destination network address range |
rules.description |
string |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedClusterSecurityGroupRequest - API Source:
rancher_cluster_security_groups_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
rules |
array of objects | ||
rules.ethertype |
any | IP protocol version - either 'IPv4' or 'IPv6' | |
rules.direction |
any | Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing) | |
rules.protocol |
any | The network protocol (TCP, UDP, ICMP, or empty for any protocol) | |
rules.from_port |
integer | Starting port number in the range (1-65535) | |
rules.to_port |
integer | Ending port number in the range (1-65535) | |
rules.cidr |
string | CIDR notation for the source/destination network address range | |
rules.description |
string |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
name |
string | |
description |
string | |
rules |
array of objects | |
rules.uuid |
string (uuid) | |
rules.ethertype |
any | IP protocol version - either 'IPv4' or 'IPv6' |
rules.direction |
any | Traffic direction - either 'ingress' (incoming) or 'egress' (outgoing) |
rules.protocol |
any | The network protocol (TCP, UDP, ICMP, or empty for any protocol) |
rules.from_port |
integer | Starting port number in the range (1-65535) |
rules.to_port |
integer | Ending port number in the range (1-65535) |
rules.cidr |
string | CIDR notation for the source/destination network address range |
rules.description |
string |
Rancher Cluster Templates
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/rancher-cluster-templates/ |
List Rancher Cluster Templates |
| GET | /api/rancher-cluster-templates/{uuid}/ |
Retrieve |
List Rancher Cluster Templates
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
rancher_cluster_templates_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
uuid |
string (uuid) |
name |
string |
description |
string |
created |
string (date-time) |
modified |
string (date-time) |
nodes |
array of objects |
nodes.min_vcpu |
integer |
nodes.min_ram |
integer |
nodes.system_volume_size |
integer |
nodes.preferred_volume_type |
string |
nodes.role |
string |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
rancher_cluster_templates_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
name |
string |
description |
string |
created |
string (date-time) |
modified |
string (date-time) |
nodes |
array of objects |
nodes.min_vcpu |
integer |
nodes.min_ram |
integer |
nodes.system_volume_size |
integer |
nodes.preferred_volume_type |
string |
nodes.role |
string |
Rancher Clusters
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/rancher-clusters/ |
List Rancher Clusters |
| GET | /api/rancher-clusters/{uuid}/ |
Retrieve |
| POST | /api/rancher-clusters/{uuid}/create_management_security_group/ |
Create management security group |
| POST | /api/rancher-clusters/{uuid}/pull/ |
Synchronize resource state |
| POST | /api/rancher-clusters/{uuid}/unlink/ |
Unlink resource |
| PUT | /api/rancher-clusters/{uuid}/ |
Update |
| PATCH | /api/rancher-clusters/{uuid}/ |
Partial Update |
| Other Actions | ||
| POST | /api/rancher-clusters/{uuid}/import_yaml/ |
Import yaml |
| POST | /api/rancher-clusters/{uuid}/set_erred/ |
Mark resource as ERRED |
| POST | /api/rancher-clusters/{uuid}/set_ok/ |
Mark resource as OK |
Core CRUD
List Rancher Clusters
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- Model Source:
CoreStates - Model Source:
RancherClusterFieldEnum - API Source:
rancher_clusters_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
backend_id |
string | Backend ID |
can_manage |
boolean | Can manage |
customer |
string (uuid) | Customer UUID |
customer_abbreviation |
string | Customer abbreviation |
customer_name |
string | Customer name |
customer_native_name |
string | Customer native name |
customer_uuid |
string (uuid) | Customer UUID |
description |
string | Description |
external_ip |
string | External IP |
field |
array | |
name |
string | Name |
name_exact |
string | Name (exact) |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
project |
string (uuid) | Project UUID |
project_name |
string | Project name |
project_uuid |
string (uuid) | Project UUID |
service_settings_name |
string | Service settings name |
service_settings_uuid |
string (uuid) | Service settings UUID |
state |
array | State |
uuid |
string (uuid) | UUID |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
nodes |
array of objects | |
nodes.url |
string (uri) | |
nodes.role |
string | Enum: agent, server |
nodes.instance |
string | |
nodes.created |
string (date-time) | |
nodes.modified |
string (date-time) | |
nodes.uuid |
string (uuid) | |
nodes.error_message |
string | |
nodes.error_traceback |
string | |
nodes.backend_id |
string | |
nodes.initial_data |
any | Initial data for instance creating. |
nodes.runtime_state |
string | |
nodes.k8s_version |
string | |
nodes.docker_version |
string | |
nodes.cpu_allocated |
number (double) | |
nodes.cpu_total |
integer | |
nodes.ram_allocated |
integer | Allocated RAM in Mi. |
nodes.ram_total |
integer | Total RAM in Mi. |
nodes.pods_allocated |
integer | |
nodes.pods_total |
integer | |
nodes.labels |
any | |
nodes.annotations |
any | |
tenant |
string (uri) | |
tenant_uuid |
string (uuid) | |
vm_project |
string (uri) | |
runtime_state |
string | |
install_longhorn |
boolean | Longhorn is a distributed block storage deployed on top of Kubernetes cluster |
management_security_group |
string (uri) | |
public_ips |
array of objects | |
public_ips.floating_ip |
string (uri) | |
public_ips.floating_ip_uuid |
string (uuid) | |
public_ips.ip_address |
any | An IPv4 or IPv6 address. |
public_ips.external_ip_address |
any | An IPv4 or IPv6 address. |
capacity |
any | Cluster capacity in the format |
requested |
any | Cluster requested resources in the format |
kubernetes_version |
string | Kubernetes version used in the cluster. |
router_ips |
array of anys | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
RancherClusterFieldEnum - API Source:
rancher_clusters_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
nodes |
array of objects | |
nodes.url |
string (uri) | |
nodes.role |
string | Enum: agent, server |
nodes.instance |
string | |
nodes.created |
string (date-time) | |
nodes.modified |
string (date-time) | |
nodes.uuid |
string (uuid) | |
nodes.error_message |
string | |
nodes.error_traceback |
string | |
nodes.backend_id |
string | |
nodes.initial_data |
any | Initial data for instance creating. |
nodes.runtime_state |
string | |
nodes.k8s_version |
string | |
nodes.docker_version |
string | |
nodes.cpu_allocated |
number (double) | |
nodes.cpu_total |
integer | |
nodes.ram_allocated |
integer | Allocated RAM in Mi. |
nodes.ram_total |
integer | Total RAM in Mi. |
nodes.pods_allocated |
integer | |
nodes.pods_total |
integer | |
nodes.labels |
any | |
nodes.annotations |
any | |
tenant |
string (uri) | |
tenant_uuid |
string (uuid) | |
vm_project |
string (uri) | |
runtime_state |
string | |
install_longhorn |
boolean | Longhorn is a distributed block storage deployed on top of Kubernetes cluster |
management_security_group |
string (uri) | |
public_ips |
array of objects | |
public_ips.floating_ip |
string (uri) | |
public_ips.floating_ip_uuid |
string (uuid) | |
public_ips.ip_address |
any | An IPv4 or IPv6 address. |
public_ips.external_ip_address |
any | An IPv4 or IPv6 address. |
capacity |
any | Cluster capacity in the format |
requested |
any | Cluster requested resources in the format |
kubernetes_version |
string | Kubernetes version used in the cluster. |
router_ips |
array of anys | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Create management security group
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
RancherClusterRequest - API Source:
rancher_clusters_create_management_security_group
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ✓ | |
description |
string | ||
vm_project |
string (uri) | ||
ssh_public_key |
string (uri) | Constraints: write-only |
|
install_longhorn |
boolean | Longhorn is a distributed block storage deployed on top of Kubernetes cluster Constraints: default: False |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
nodes |
array of objects | |
nodes.url |
string (uri) | |
nodes.role |
string | Enum: agent, server |
nodes.instance |
string | |
nodes.created |
string (date-time) | |
nodes.modified |
string (date-time) | |
nodes.uuid |
string (uuid) | |
nodes.error_message |
string | |
nodes.error_traceback |
string | |
nodes.backend_id |
string | |
nodes.initial_data |
any | Initial data for instance creating. |
nodes.runtime_state |
string | |
nodes.k8s_version |
string | |
nodes.docker_version |
string | |
nodes.cpu_allocated |
number (double) | |
nodes.cpu_total |
integer | |
nodes.ram_allocated |
integer | Allocated RAM in Mi. |
nodes.ram_total |
integer | Total RAM in Mi. |
nodes.pods_allocated |
integer | |
nodes.pods_total |
integer | |
nodes.labels |
any | |
nodes.annotations |
any | |
tenant |
string (uri) | |
tenant_uuid |
string (uuid) | |
vm_project |
string (uri) | |
runtime_state |
string | |
install_longhorn |
boolean | Longhorn is a distributed block storage deployed on top of Kubernetes cluster |
management_security_group |
string (uri) | |
public_ips |
array of objects | |
public_ips.floating_ip |
string (uri) | |
public_ips.floating_ip_uuid |
string (uuid) | |
public_ips.ip_address |
any | An IPv4 or IPv6 address. |
public_ips.external_ip_address |
any | An IPv4 or IPv6 address. |
capacity |
any | Cluster capacity in the format |
requested |
any | Cluster requested resources in the format |
kubernetes_version |
string | Kubernetes version used in the cluster. |
router_ips |
array of anys | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Synchronize resource state
Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
rancher_clusters_pull
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
202 -
| Field | Type |
|---|---|
detail |
string |
409 -
| Field | Type |
|---|---|
detail |
string |
Unlink resource
Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
rancher_clusters_unlink
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Update
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
RancherClusterRequest - API Source:
rancher_clusters_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ✓ | |
description |
string | ||
vm_project |
string (uri) | ||
ssh_public_key |
string (uri) | Constraints: write-only |
|
install_longhorn |
boolean | Longhorn is a distributed block storage deployed on top of Kubernetes cluster Constraints: default: False |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
nodes |
array of objects | |
nodes.url |
string (uri) | |
nodes.role |
string | Enum: agent, server |
nodes.instance |
string | |
nodes.created |
string (date-time) | |
nodes.modified |
string (date-time) | |
nodes.uuid |
string (uuid) | |
nodes.error_message |
string | |
nodes.error_traceback |
string | |
nodes.backend_id |
string | |
nodes.initial_data |
any | Initial data for instance creating. |
nodes.runtime_state |
string | |
nodes.k8s_version |
string | |
nodes.docker_version |
string | |
nodes.cpu_allocated |
number (double) | |
nodes.cpu_total |
integer | |
nodes.ram_allocated |
integer | Allocated RAM in Mi. |
nodes.ram_total |
integer | Total RAM in Mi. |
nodes.pods_allocated |
integer | |
nodes.pods_total |
integer | |
nodes.labels |
any | |
nodes.annotations |
any | |
tenant |
string (uri) | |
tenant_uuid |
string (uuid) | |
vm_project |
string (uri) | |
runtime_state |
string | |
install_longhorn |
boolean | Longhorn is a distributed block storage deployed on top of Kubernetes cluster |
management_security_group |
string (uri) | |
public_ips |
array of objects | |
public_ips.floating_ip |
string (uri) | |
public_ips.floating_ip_uuid |
string (uuid) | |
public_ips.ip_address |
any | An IPv4 or IPv6 address. |
public_ips.external_ip_address |
any | An IPv4 or IPv6 address. |
capacity |
any | Cluster capacity in the format |
requested |
any | Cluster requested resources in the format |
kubernetes_version |
string | Kubernetes version used in the cluster. |
router_ips |
array of anys | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedRancherClusterRequest - API Source:
rancher_clusters_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ||
description |
string | ||
vm_project |
string (uri) | ||
ssh_public_key |
string (uri) | Constraints: write-only |
|
install_longhorn |
boolean | Longhorn is a distributed block storage deployed on top of Kubernetes cluster Constraints: default: False |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
nodes |
array of objects | |
nodes.url |
string (uri) | |
nodes.role |
string | Enum: agent, server |
nodes.instance |
string | |
nodes.created |
string (date-time) | |
nodes.modified |
string (date-time) | |
nodes.uuid |
string (uuid) | |
nodes.error_message |
string | |
nodes.error_traceback |
string | |
nodes.backend_id |
string | |
nodes.initial_data |
any | Initial data for instance creating. |
nodes.runtime_state |
string | |
nodes.k8s_version |
string | |
nodes.docker_version |
string | |
nodes.cpu_allocated |
number (double) | |
nodes.cpu_total |
integer | |
nodes.ram_allocated |
integer | Allocated RAM in Mi. |
nodes.ram_total |
integer | Total RAM in Mi. |
nodes.pods_allocated |
integer | |
nodes.pods_total |
integer | |
nodes.labels |
any | |
nodes.annotations |
any | |
tenant |
string (uri) | |
tenant_uuid |
string (uuid) | |
vm_project |
string (uri) | |
runtime_state |
string | |
install_longhorn |
boolean | Longhorn is a distributed block storage deployed on top of Kubernetes cluster |
management_security_group |
string (uri) | |
public_ips |
array of objects | |
public_ips.floating_ip |
string (uri) | |
public_ips.floating_ip_uuid |
string (uuid) | |
public_ips.ip_address |
any | An IPv4 or IPv6 address. |
public_ips.external_ip_address |
any | An IPv4 or IPv6 address. |
capacity |
any | Cluster capacity in the format |
requested |
any | Cluster requested resources in the format |
kubernetes_version |
string | Kubernetes version used in the cluster. |
router_ips |
array of anys | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Other Actions
Import yaml
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
RancherImportYamlRequest - API Source:
rancher_clusters_import_yaml
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
yaml |
string | ✓ |
default_namespace |
string (uri) | |
namespace |
string (uri) |
200 -
| Field | Type |
|---|---|
yaml |
string |
default_namespace |
string (uri) |
namespace |
string (uri) |
Mark resource as ERRED
Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
SetErredRequest - API Source:
rancher_clusters_set_erred
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
error_message |
string | |
error_traceback |
string |
200 -
| Field | Type |
|---|---|
detail |
string |
Mark resource as OK
Manually transition the resource to OK state and clear error fields. Staff-only operation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
rancher_clusters_set_ok
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
detail |
string |
Rancher Hpas
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/rancher-hpas/ |
List Rancher Hpas |
| GET | /api/rancher-hpas/{uuid}/ |
Retrieve |
| POST | /api/rancher-hpas/ |
Create |
| POST | /api/rancher-hpas/{uuid}/pull/ |
Synchronize resource state |
| POST | /api/rancher-hpas/{uuid}/unlink/ |
Unlink resource |
| PUT | /api/rancher-hpas/{uuid}/ |
Update |
| PATCH | /api/rancher-hpas/{uuid}/ |
Partial Update |
| DELETE | /api/rancher-hpas/{uuid}/ |
Delete |
| Other Actions | ||
| GET | /api/rancher-hpas/{uuid}/yaml/ |
Yaml |
| POST | /api/rancher-hpas/{uuid}/set_erred/ |
Mark resource as ERRED |
| POST | /api/rancher-hpas/{uuid}/set_ok/ |
Mark resource as OK |
| PUT | /api/rancher-hpas/{uuid}/yaml/ |
Yaml |
Core CRUD
List Rancher Hpas
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
rancher_hpas_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
cluster_uuid |
string (uuid) | |
name |
string | Name |
name_exact |
string | Name (exact) |
namespace_uuid |
string (uuid) | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
project_uuid |
string (uuid) | |
settings |
string (uri) | Settings URL |
settings_uuid |
string (uuid) | Settings UUID |
workload_uuid |
string (uuid) |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
description |
string |
created |
string (date-time) |
modified |
string (date-time) |
runtime_state |
string |
cluster |
string (uri) |
cluster_uuid |
string (uuid) |
cluster_name |
string |
project |
string (uri) |
project_uuid |
string (uuid) |
project_name |
string |
namespace |
string (uri) |
namespace_uuid |
string (uuid) |
namespace_name |
string |
workload |
string (uri) |
workload_uuid |
string (uuid) |
workload_name |
string |
min_replicas |
integer |
max_replicas |
integer |
current_replicas |
integer |
desired_replicas |
integer |
metrics |
any |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
rancher_hpas_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
description |
string |
created |
string (date-time) |
modified |
string (date-time) |
runtime_state |
string |
cluster |
string (uri) |
cluster_uuid |
string (uuid) |
cluster_name |
string |
project |
string (uri) |
project_uuid |
string (uuid) |
project_name |
string |
namespace |
string (uri) |
namespace_uuid |
string (uuid) |
namespace_name |
string |
workload |
string (uri) |
workload_uuid |
string (uuid) |
workload_name |
string |
min_replicas |
integer |
max_replicas |
integer |
current_replicas |
integer |
desired_replicas |
integer |
metrics |
any |
Create
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
RancherHPARequest - API Source:
rancher_hpas_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Field | Type | Required |
|---|---|---|
name |
string | ✓ |
description |
string | |
workload |
string (uri) | |
min_replicas |
integer | |
max_replicas |
integer | |
metrics |
any | ✓ |
201 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
description |
string |
created |
string (date-time) |
modified |
string (date-time) |
runtime_state |
string |
cluster |
string (uri) |
cluster_uuid |
string (uuid) |
cluster_name |
string |
project |
string (uri) |
project_uuid |
string (uuid) |
project_name |
string |
namespace |
string (uri) |
namespace_uuid |
string (uuid) |
namespace_name |
string |
workload |
string (uri) |
workload_uuid |
string (uuid) |
workload_name |
string |
min_replicas |
integer |
max_replicas |
integer |
current_replicas |
integer |
desired_replicas |
integer |
metrics |
any |
Synchronize resource state
Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
rancher_hpas_pull
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
202 -
| Field | Type |
|---|---|
detail |
string |
409 -
| Field | Type |
|---|---|
detail |
string |
Unlink resource
Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
rancher_hpas_unlink
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Update
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
RancherHPARequest - API Source:
rancher_hpas_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
name |
string | ✓ |
description |
string | |
workload |
string (uri) | |
min_replicas |
integer | |
max_replicas |
integer | |
metrics |
any | ✓ |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
description |
string |
created |
string (date-time) |
modified |
string (date-time) |
runtime_state |
string |
cluster |
string (uri) |
cluster_uuid |
string (uuid) |
cluster_name |
string |
project |
string (uri) |
project_uuid |
string (uuid) |
project_name |
string |
namespace |
string (uri) |
namespace_uuid |
string (uuid) |
namespace_name |
string |
workload |
string (uri) |
workload_uuid |
string (uuid) |
workload_name |
string |
min_replicas |
integer |
max_replicas |
integer |
current_replicas |
integer |
desired_replicas |
integer |
metrics |
any |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedRancherHPARequest - API Source:
rancher_hpas_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
name |
string | |
description |
string | |
workload |
string (uri) | |
min_replicas |
integer | |
max_replicas |
integer | |
metrics |
any |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
description |
string |
created |
string (date-time) |
modified |
string (date-time) |
runtime_state |
string |
cluster |
string (uri) |
cluster_uuid |
string (uuid) |
cluster_name |
string |
project |
string (uri) |
project_uuid |
string (uuid) |
project_name |
string |
namespace |
string (uri) |
namespace_uuid |
string (uuid) |
namespace_name |
string |
workload |
string (uri) |
workload_uuid |
string (uuid) |
workload_name |
string |
min_replicas |
integer |
max_replicas |
integer |
current_replicas |
integer |
desired_replicas |
integer |
metrics |
any |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
rancher_hpas_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
Yaml
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
rancher_hpas_yaml_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
description |
string |
created |
string (date-time) |
modified |
string (date-time) |
runtime_state |
string |
cluster |
string (uri) |
cluster_uuid |
string (uuid) |
cluster_name |
string |
project |
string (uri) |
project_uuid |
string (uuid) |
project_name |
string |
namespace |
string (uri) |
namespace_uuid |
string (uuid) |
namespace_name |
string |
workload |
string (uri) |
workload_uuid |
string (uuid) |
workload_name |
string |
min_replicas |
integer |
max_replicas |
integer |
current_replicas |
integer |
desired_replicas |
integer |
metrics |
any |
Mark resource as ERRED
Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
SetErredRequest - API Source:
rancher_hpas_set_erred
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
error_message |
string | |
error_traceback |
string |
200 -
| Field | Type |
|---|---|
detail |
string |
Mark resource as OK
Manually transition the resource to OK state and clear error fields. Staff-only operation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
rancher_hpas_set_ok
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
detail |
string |
Yaml
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
RancherHPARequest - API Source:
rancher_hpas_yaml_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
name |
string | ✓ |
description |
string | |
workload |
string (uri) | |
min_replicas |
integer | |
max_replicas |
integer | |
metrics |
any | ✓ |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
description |
string |
created |
string (date-time) |
modified |
string (date-time) |
runtime_state |
string |
cluster |
string (uri) |
cluster_uuid |
string (uuid) |
cluster_name |
string |
project |
string (uri) |
project_uuid |
string (uuid) |
project_name |
string |
namespace |
string (uri) |
namespace_uuid |
string (uuid) |
namespace_name |
string |
workload |
string (uri) |
workload_uuid |
string (uuid) |
workload_name |
string |
min_replicas |
integer |
max_replicas |
integer |
current_replicas |
integer |
desired_replicas |
integer |
metrics |
any |
Rancher Ingresses
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/rancher-ingresses/ |
List Rancher Ingresses |
| GET | /api/rancher-ingresses/{uuid}/ |
Retrieve |
| POST | /api/rancher-ingresses/ |
Create |
| POST | /api/rancher-ingresses/{uuid}/pull/ |
Synchronize resource state |
| POST | /api/rancher-ingresses/{uuid}/unlink/ |
Unlink resource |
| PUT | /api/rancher-ingresses/{uuid}/ |
Update |
| PATCH | /api/rancher-ingresses/{uuid}/ |
Partial Update |
| DELETE | /api/rancher-ingresses/{uuid}/ |
Delete |
| Other Actions | ||
| GET | /api/rancher-ingresses/{uuid}/yaml/ |
Yaml |
| POST | /api/rancher-ingresses/{uuid}/set_erred/ |
Mark resource as ERRED |
| POST | /api/rancher-ingresses/{uuid}/set_ok/ |
Mark resource as OK |
| PUT | /api/rancher-ingresses/{uuid}/yaml/ |
Yaml |
Core CRUD
List Rancher Ingresses
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- Model Source:
CoreStates - Model Source:
RancherIngressFieldEnum - API Source:
rancher_ingresses_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
backend_id |
string | Backend ID |
can_manage |
boolean | Can manage |
cluster_uuid |
string (uuid) | |
customer |
string (uuid) | Customer UUID |
customer_abbreviation |
string | Customer abbreviation |
customer_name |
string | Customer name |
customer_native_name |
string | Customer native name |
customer_uuid |
string (uuid) | Customer UUID |
description |
string | Description |
external_ip |
string | External IP |
field |
array | |
name |
string | Name |
name_exact |
string | Name (exact) |
namespace_uuid |
string (uuid) | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
project |
string (uuid) | Project UUID |
project_name |
string | Project name |
project_uuid |
string (uuid) | Project UUID |
rancher_project_uuid |
string (uuid) | |
service_settings_name |
string | Service settings name |
service_settings_uuid |
string (uuid) | Service settings UUID |
state |
array | State |
uuid |
string (uuid) | UUID |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
description |
string |
service_name |
string |
service_settings |
string (uri) |
service_settings_uuid |
string (uuid) |
service_settings_state |
string |
service_settings_error_message |
string |
project |
string (uri) |
project_name |
string |
project_uuid |
string (uuid) |
customer |
string (uri) |
customer_uuid |
string (uuid) |
customer_name |
string |
customer_native_name |
string |
customer_abbreviation |
string |
error_message |
string |
error_traceback |
string |
resource_type |
string |
state |
any |
created |
string (date-time) |
modified |
string (date-time) |
backend_id |
string |
access_url |
string |
runtime_state |
string |
rancher_project |
string (uri) |
rancher_project_name |
string |
namespace |
string (uri) |
namespace_name |
string |
rules |
any |
marketplace_offering_uuid |
string |
marketplace_offering_name |
string |
marketplace_offering_plugin_options |
object (free-form) |
marketplace_category_uuid |
string |
marketplace_category_name |
string |
marketplace_resource_uuid |
string |
marketplace_plan_uuid |
string |
marketplace_resource_state |
string |
is_usage_based |
boolean |
is_limit_based |
boolean |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
RancherIngressFieldEnum - API Source:
rancher_ingresses_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
description |
string |
service_name |
string |
service_settings |
string (uri) |
service_settings_uuid |
string (uuid) |
service_settings_state |
string |
service_settings_error_message |
string |
project |
string (uri) |
project_name |
string |
project_uuid |
string (uuid) |
customer |
string (uri) |
customer_uuid |
string (uuid) |
customer_name |
string |
customer_native_name |
string |
customer_abbreviation |
string |
error_message |
string |
error_traceback |
string |
resource_type |
string |
state |
any |
created |
string (date-time) |
modified |
string (date-time) |
backend_id |
string |
access_url |
string |
runtime_state |
string |
rancher_project |
string (uri) |
rancher_project_name |
string |
namespace |
string (uri) |
namespace_name |
string |
rules |
any |
marketplace_offering_uuid |
string |
marketplace_offering_name |
string |
marketplace_offering_plugin_options |
object (free-form) |
marketplace_category_uuid |
string |
marketplace_category_name |
string |
marketplace_resource_uuid |
string |
marketplace_plan_uuid |
string |
marketplace_resource_state |
string |
is_usage_based |
boolean |
is_limit_based |
boolean |
Create
1 2 3 4 5 6 7 8 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | |
- Model Source:
RancherIngressRequest - API Source:
rancher_ingresses_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Field | Type | Required |
|---|---|---|
name |
string | ✓ |
description |
string | |
service_settings |
string (uri) | ✓ |
project |
string (uri) | ✓ |
error_message |
string | |
error_traceback |
string | |
backend_id |
string | |
runtime_state |
string | |
rancher_project |
string (uri) | ✓ |
namespace |
string (uri) | |
rules |
any |
201 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
description |
string |
service_name |
string |
service_settings |
string (uri) |
service_settings_uuid |
string (uuid) |
service_settings_state |
string |
service_settings_error_message |
string |
project |
string (uri) |
project_name |
string |
project_uuid |
string (uuid) |
customer |
string (uri) |
customer_uuid |
string (uuid) |
customer_name |
string |
customer_native_name |
string |
customer_abbreviation |
string |
error_message |
string |
error_traceback |
string |
resource_type |
string |
state |
any |
created |
string (date-time) |
modified |
string (date-time) |
backend_id |
string |
access_url |
string |
runtime_state |
string |
rancher_project |
string (uri) |
rancher_project_name |
string |
namespace |
string (uri) |
namespace_name |
string |
rules |
any |
marketplace_offering_uuid |
string |
marketplace_offering_name |
string |
marketplace_offering_plugin_options |
object (free-form) |
marketplace_category_uuid |
string |
marketplace_category_name |
string |
marketplace_resource_uuid |
string |
marketplace_plan_uuid |
string |
marketplace_resource_state |
string |
is_usage_based |
boolean |
is_limit_based |
boolean |
Synchronize resource state
Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
rancher_ingresses_pull
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
202 -
| Field | Type |
|---|---|
detail |
string |
409 -
| Field | Type |
|---|---|
detail |
string |
Unlink resource
Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
rancher_ingresses_unlink
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Update
1 2 3 4 5 6 7 8 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 | |
- Model Source:
RancherIngressRequest - API Source:
rancher_ingresses_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
name |
string | ✓ |
description |
string | |
service_settings |
string (uri) | ✓ |
project |
string (uri) | ✓ |
error_message |
string | |
error_traceback |
string | |
backend_id |
string | |
runtime_state |
string | |
rancher_project |
string (uri) | ✓ |
namespace |
string (uri) | |
rules |
any |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
description |
string |
service_name |
string |
service_settings |
string (uri) |
service_settings_uuid |
string (uuid) |
service_settings_state |
string |
service_settings_error_message |
string |
project |
string (uri) |
project_name |
string |
project_uuid |
string (uuid) |
customer |
string (uri) |
customer_uuid |
string (uuid) |
customer_name |
string |
customer_native_name |
string |
customer_abbreviation |
string |
error_message |
string |
error_traceback |
string |
resource_type |
string |
state |
any |
created |
string (date-time) |
modified |
string (date-time) |
backend_id |
string |
access_url |
string |
runtime_state |
string |
rancher_project |
string (uri) |
rancher_project_name |
string |
namespace |
string (uri) |
namespace_name |
string |
rules |
any |
marketplace_offering_uuid |
string |
marketplace_offering_name |
string |
marketplace_offering_plugin_options |
object (free-form) |
marketplace_category_uuid |
string |
marketplace_category_name |
string |
marketplace_resource_uuid |
string |
marketplace_plan_uuid |
string |
marketplace_resource_state |
string |
is_usage_based |
boolean |
is_limit_based |
boolean |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedRancherIngressRequest - API Source:
rancher_ingresses_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
name |
string | |
description |
string | |
service_settings |
string (uri) | |
project |
string (uri) | |
error_message |
string | |
error_traceback |
string | |
backend_id |
string | |
runtime_state |
string | |
rancher_project |
string (uri) | |
namespace |
string (uri) | |
rules |
any |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
description |
string |
service_name |
string |
service_settings |
string (uri) |
service_settings_uuid |
string (uuid) |
service_settings_state |
string |
service_settings_error_message |
string |
project |
string (uri) |
project_name |
string |
project_uuid |
string (uuid) |
customer |
string (uri) |
customer_uuid |
string (uuid) |
customer_name |
string |
customer_native_name |
string |
customer_abbreviation |
string |
error_message |
string |
error_traceback |
string |
resource_type |
string |
state |
any |
created |
string (date-time) |
modified |
string (date-time) |
backend_id |
string |
access_url |
string |
runtime_state |
string |
rancher_project |
string (uri) |
rancher_project_name |
string |
namespace |
string (uri) |
namespace_name |
string |
rules |
any |
marketplace_offering_uuid |
string |
marketplace_offering_name |
string |
marketplace_offering_plugin_options |
object (free-form) |
marketplace_category_uuid |
string |
marketplace_category_name |
string |
marketplace_resource_uuid |
string |
marketplace_plan_uuid |
string |
marketplace_resource_state |
string |
is_usage_based |
boolean |
is_limit_based |
boolean |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
rancher_ingresses_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
Yaml
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
RancherIngressFieldEnum - API Source:
rancher_ingresses_yaml_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
description |
string |
service_name |
string |
service_settings |
string (uri) |
service_settings_uuid |
string (uuid) |
service_settings_state |
string |
service_settings_error_message |
string |
project |
string (uri) |
project_name |
string |
project_uuid |
string (uuid) |
customer |
string (uri) |
customer_uuid |
string (uuid) |
customer_name |
string |
customer_native_name |
string |
customer_abbreviation |
string |
error_message |
string |
error_traceback |
string |
resource_type |
string |
state |
any |
created |
string (date-time) |
modified |
string (date-time) |
backend_id |
string |
access_url |
string |
runtime_state |
string |
rancher_project |
string (uri) |
rancher_project_name |
string |
namespace |
string (uri) |
namespace_name |
string |
rules |
any |
marketplace_offering_uuid |
string |
marketplace_offering_name |
string |
marketplace_offering_plugin_options |
object (free-form) |
marketplace_category_uuid |
string |
marketplace_category_name |
string |
marketplace_resource_uuid |
string |
marketplace_plan_uuid |
string |
marketplace_resource_state |
string |
is_usage_based |
boolean |
is_limit_based |
boolean |
Mark resource as ERRED
Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
SetErredRequest - API Source:
rancher_ingresses_set_erred
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
error_message |
string | |
error_traceback |
string |
200 -
| Field | Type |
|---|---|
detail |
string |
Mark resource as OK
Manually transition the resource to OK state and clear error fields. Staff-only operation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
rancher_ingresses_set_ok
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
detail |
string |
Yaml
1 2 3 4 5 6 7 8 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 | |
- Model Source:
RancherIngressRequest - API Source:
rancher_ingresses_yaml_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
name |
string | ✓ |
description |
string | |
service_settings |
string (uri) | ✓ |
project |
string (uri) | ✓ |
error_message |
string | |
error_traceback |
string | |
backend_id |
string | |
runtime_state |
string | |
rancher_project |
string (uri) | ✓ |
namespace |
string (uri) | |
rules |
any |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
description |
string |
service_name |
string |
service_settings |
string (uri) |
service_settings_uuid |
string (uuid) |
service_settings_state |
string |
service_settings_error_message |
string |
project |
string (uri) |
project_name |
string |
project_uuid |
string (uuid) |
customer |
string (uri) |
customer_uuid |
string (uuid) |
customer_name |
string |
customer_native_name |
string |
customer_abbreviation |
string |
error_message |
string |
error_traceback |
string |
resource_type |
string |
state |
any |
created |
string (date-time) |
modified |
string (date-time) |
backend_id |
string |
access_url |
string |
runtime_state |
string |
rancher_project |
string (uri) |
rancher_project_name |
string |
namespace |
string (uri) |
namespace_name |
string |
rules |
any |
marketplace_offering_uuid |
string |
marketplace_offering_name |
string |
marketplace_offering_plugin_options |
object (free-form) |
marketplace_category_uuid |
string |
marketplace_category_name |
string |
marketplace_resource_uuid |
string |
marketplace_plan_uuid |
string |
marketplace_resource_state |
string |
is_usage_based |
boolean |
is_limit_based |
boolean |
Keycloak Groups
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/keycloak-groups/ |
List Keycloak Groups |
| GET | /api/keycloak-groups/{uuid}/ |
Retrieve |
List Keycloak Groups
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
keycloak_groups_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
role |
string | |
scope_type |
string | |
scope_uuid |
string (uuid) |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
name |
string | |
backend_id |
string | |
scope_type |
string | |
scope_uuid |
string (uuid) | UUID of the cluster or project |
scope_name |
string | Get the name of the cluster or project |
role |
string (uri) | |
created |
string (date-time) | |
modified |
string (date-time) |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
keycloak_groups_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
name |
string | |
backend_id |
string | |
scope_type |
string | |
scope_uuid |
string (uuid) | UUID of the cluster or project |
scope_name |
string | Get the name of the cluster or project |
role |
string (uri) | |
created |
string (date-time) | |
modified |
string (date-time) |
Keycloak User Group Memberships
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/keycloak-user-group-memberships/ |
List Keycloak User Group Memberships |
| GET | /api/keycloak-user-group-memberships/{uuid}/ |
Retrieve |
| POST | /api/keycloak-user-group-memberships/ |
Create |
| PUT | /api/keycloak-user-group-memberships/{uuid}/ |
Update |
| PATCH | /api/keycloak-user-group-memberships/{uuid}/ |
Partial Update |
| DELETE | /api/keycloak-user-group-memberships/{uuid}/ |
Delete |
List Keycloak User Group Memberships
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 | |
- Model Source:
KeycloakUserGroupMembershipState - API Source:
keycloak_user_group_memberships_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
email |
string | |
first_name |
string | |
group_uuid |
string (uuid) | |
last_name |
string | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
role_uuid |
string (uuid) | |
scope_type |
string | |
scope_uuid |
string (uuid) | |
state |
array | |
username |
string |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
username |
string | Keycloak user username |
email |
string (email) | User's email for notifications |
first_name |
string | |
last_name |
string | |
group |
string (uri) | |
group_name |
string | |
group_role |
string | |
group_scope_type |
string | |
group_scope_name |
string | Get the name of the cluster or project |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
last_checked |
string (date-time) | |
error_message |
string | |
error_traceback |
string |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
keycloak_user_group_memberships_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
username |
string | Keycloak user username |
email |
string (email) | User's email for notifications |
first_name |
string | |
last_name |
string | |
group |
string (uri) | |
group_name |
string | |
group_role |
string | |
group_scope_type |
string | |
group_scope_name |
string | Get the name of the cluster or project |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
last_checked |
string (date-time) | |
error_message |
string | |
error_traceback |
string |
Create
1 2 3 4 5 6 7 8 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | |
- Model Source:
KeycloakUserGroupMembershipRequest - API Source:
keycloak_user_group_memberships_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Field | Type | Required | Description |
|---|---|---|---|
username |
string | ✓ | Keycloak user username |
email |
string (email) | ✓ | User's email for notifications |
scope_uuid |
string (uuid) | ✓ | UUID of a cluster or a project in Rancher Constraints: write-only |
role |
string (uri) | ✓ | Constraints: write-only |
201 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
username |
string | Keycloak user username |
email |
string (email) | User's email for notifications |
first_name |
string | |
last_name |
string | |
group |
string (uri) | |
group_name |
string | |
group_role |
string | |
group_scope_type |
string | |
group_scope_name |
string | Get the name of the cluster or project |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
last_checked |
string (date-time) | |
error_message |
string | |
error_traceback |
string |
Update
1 2 3 4 5 6 7 8 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 | |
- Model Source:
KeycloakUserGroupMembershipRequest - API Source:
keycloak_user_group_memberships_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
username |
string | ✓ | Keycloak user username |
email |
string (email) | ✓ | User's email for notifications |
scope_uuid |
string (uuid) | ✓ | UUID of a cluster or a project in Rancher Constraints: write-only |
role |
string (uri) | ✓ | Constraints: write-only |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
username |
string | Keycloak user username |
email |
string (email) | User's email for notifications |
first_name |
string | |
last_name |
string | |
group |
string (uri) | |
group_name |
string | |
group_role |
string | |
group_scope_type |
string | |
group_scope_name |
string | Get the name of the cluster or project |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
last_checked |
string (date-time) | |
error_message |
string | |
error_traceback |
string |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedKeycloakUserGroupMembershipRequest - API Source:
keycloak_user_group_memberships_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
username |
string | Keycloak user username | |
email |
string (email) | User's email for notifications | |
scope_uuid |
string (uuid) | UUID of a cluster or a project in Rancher Constraints: write-only |
|
role |
string (uri) | Constraints: write-only |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
username |
string | Keycloak user username |
email |
string (email) | User's email for notifications |
first_name |
string | |
last_name |
string | |
group |
string (uri) | |
group_name |
string | |
group_role |
string | |
group_scope_type |
string | |
group_scope_name |
string | Get the name of the cluster or project |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
last_checked |
string (date-time) | |
error_message |
string | |
error_traceback |
string |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
keycloak_user_group_memberships_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Managed Rancher Cluster Resources
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/managed-rancher-cluster-resources/ |
List Managed Rancher Cluster Resources |
| GET | /api/managed-rancher-cluster-resources/{uuid}/ |
Retrieve |
| Other Actions | ||
| POST | /api/managed-rancher-cluster-resources/{uuid}/add_node/ |
Add node |
Core CRUD
List Managed Rancher Cluster Resources
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 | |
- Model Source:
ResourceFieldEnum - API Source:
managed_rancher_cluster_resources_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
field |
array | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
offering |
string (uri) | |
offering_name |
string | |
offering_uuid |
string (uuid) | |
offering_description |
string | |
offering_image |
string (uri) | |
offering_thumbnail |
string (uri) | |
offering_type |
string | |
offering_shared |
boolean | Accessible to all customers. |
offering_billable |
boolean | Purchase and usage is invoiced. |
offering_plugin_options |
any | Public data used by specific plugin, such as storage mode for OpenStack. |
provider_name |
string | |
provider_uuid |
string (uuid) | |
provider_slug |
string | |
category_title |
string | |
category_uuid |
string (uuid) | |
category_icon |
string (uri) | |
plan |
string (uri) | |
plan_unit |
any | |
plan_name |
string | |
plan_uuid |
string (uuid) | |
plan_description |
string | |
attributes |
object (free-form) | |
limits |
object (free-form) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
modified |
string (date-time) | |
url |
string (uri) | |
scope |
string | |
description |
string | |
state |
any | |
resource_uuid |
string (uuid) | |
backend_id |
string | |
effective_id |
string | |
resource_type |
string | |
project |
string (uri) | |
project_uuid |
string (uuid) | |
project_name |
string | |
project_description |
string | |
project_end_date |
string (date) | The date is inclusive. Once reached, all project resource will be scheduled for termination. |
project_end_date_requested_by |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
offering_slug |
string | |
parent_offering_uuid |
string (uuid) | |
parent_offering_name |
string | |
parent_offering_slug |
string | |
offering_backend_id |
string | |
parent_uuid |
string (uuid) | |
parent_name |
string | |
backend_metadata |
any | |
is_usage_based |
boolean | Returns True if the resource has usage-based components that track variable consumption. |
is_limit_based |
boolean | Returns True if the resource has limit-based components with user-adjustable quotas. |
name |
string | |
slug |
string | URL-friendly identifier. Only editable by staff users. |
current_usages |
object (free-form) | Dictionary mapping component types to their latest reported usage amounts. |
can_terminate |
boolean | |
report |
array of objects | |
report.header |
string | Section header text |
report.body |
string | Section body content |
end_date |
string (date) | The date is inclusive. Once reached, a resource will be scheduled for termination. |
end_date_requested_by |
string (uri) | |
username |
string | |
limit_usage |
object (free-form) | Dictionary mapping limit-based component types to their consumed usage. For monthly periods, maps from current_usages; for longer periods, aggregates historical usage. |
downscaled |
boolean | |
restrict_member_access |
boolean | |
paused |
boolean | |
endpoints |
array of objects | |
endpoints.uuid |
string (uuid) | |
endpoints.name |
string | |
endpoints.url |
string | URL of the access endpoint |
error_message |
string | |
error_traceback |
string | |
options |
any | |
available_actions |
array of strings | |
last_sync |
string (date-time) | |
order_in_progress |
any | |
creation_order |
any | |
service_settings_uuid |
string (uuid) | |
project_slug |
string | |
customer_slug |
string | |
user_requires_reconsent |
boolean | Check if the current user needs to re-consent for this resource's offering. |
renewal_date |
object (free-form) | |
offering_state |
any | |
offering_components |
array of objects | |
offering_components.uuid |
string (uuid) | |
offering_components.billing_type |
string | Enum: fixed, usage, limit, one, few |
offering_components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
offering_components.name |
string | Display name for the measured unit, for example, Floating IP. |
offering_components.description |
string | |
offering_components.measured_unit |
string | Unit of measurement, for example, GB. |
offering_components.unit_factor |
integer | The conversion factor from backend units to measured_unit |
offering_components.limit_period |
any | |
offering_components.limit_amount |
integer | |
offering_components.article_code |
string | |
offering_components.max_value |
integer | |
offering_components.min_value |
integer | |
offering_components.max_available_limit |
integer | |
offering_components.is_boolean |
boolean | |
offering_components.default_limit |
integer | |
offering_components.factor |
integer | |
offering_components.is_builtin |
boolean | |
offering_components.is_prepaid |
boolean | |
offering_components.overage_component |
string (uuid) | |
offering_components.min_prepaid_duration |
integer | |
offering_components.max_prepaid_duration |
integer |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
ResourceFieldEnum - API Source:
managed_rancher_cluster_resources_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type | Description |
|---|---|---|
offering |
string (uri) | |
offering_name |
string | |
offering_uuid |
string (uuid) | |
offering_description |
string | |
offering_image |
string (uri) | |
offering_thumbnail |
string (uri) | |
offering_type |
string | |
offering_shared |
boolean | Accessible to all customers. |
offering_billable |
boolean | Purchase and usage is invoiced. |
offering_plugin_options |
any | Public data used by specific plugin, such as storage mode for OpenStack. |
provider_name |
string | |
provider_uuid |
string (uuid) | |
provider_slug |
string | |
category_title |
string | |
category_uuid |
string (uuid) | |
category_icon |
string (uri) | |
plan |
string (uri) | |
plan_unit |
any | |
plan_name |
string | |
plan_uuid |
string (uuid) | |
plan_description |
string | |
attributes |
object (free-form) | |
limits |
object (free-form) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
modified |
string (date-time) | |
url |
string (uri) | |
scope |
string | |
description |
string | |
state |
any | |
resource_uuid |
string (uuid) | |
backend_id |
string | |
effective_id |
string | |
resource_type |
string | |
project |
string (uri) | |
project_uuid |
string (uuid) | |
project_name |
string | |
project_description |
string | |
project_end_date |
string (date) | The date is inclusive. Once reached, all project resource will be scheduled for termination. |
project_end_date_requested_by |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
offering_slug |
string | |
parent_offering_uuid |
string (uuid) | |
parent_offering_name |
string | |
parent_offering_slug |
string | |
offering_backend_id |
string | |
parent_uuid |
string (uuid) | |
parent_name |
string | |
backend_metadata |
any | |
is_usage_based |
boolean | Returns True if the resource has usage-based components that track variable consumption. |
is_limit_based |
boolean | Returns True if the resource has limit-based components with user-adjustable quotas. |
name |
string | |
slug |
string | URL-friendly identifier. Only editable by staff users. |
current_usages |
object (free-form) | Dictionary mapping component types to their latest reported usage amounts. |
can_terminate |
boolean | |
report |
array of objects | |
report.header |
string | Section header text |
report.body |
string | Section body content |
end_date |
string (date) | The date is inclusive. Once reached, a resource will be scheduled for termination. |
end_date_requested_by |
string (uri) | |
username |
string | |
limit_usage |
object (free-form) | Dictionary mapping limit-based component types to their consumed usage. For monthly periods, maps from current_usages; for longer periods, aggregates historical usage. |
downscaled |
boolean | |
restrict_member_access |
boolean | |
paused |
boolean | |
endpoints |
array of objects | |
endpoints.uuid |
string (uuid) | |
endpoints.name |
string | |
endpoints.url |
string | URL of the access endpoint |
error_message |
string | |
error_traceback |
string | |
options |
any | |
available_actions |
array of strings | |
last_sync |
string (date-time) | |
order_in_progress |
any | |
creation_order |
any | |
service_settings_uuid |
string (uuid) | |
project_slug |
string | |
customer_slug |
string | |
user_requires_reconsent |
boolean | Check if the current user needs to re-consent for this resource's offering. |
renewal_date |
object (free-form) | |
offering_state |
any | |
offering_components |
array of objects | |
offering_components.uuid |
string (uuid) | |
offering_components.billing_type |
string | Enum: fixed, usage, limit, one, few |
offering_components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
offering_components.name |
string | Display name for the measured unit, for example, Floating IP. |
offering_components.description |
string | |
offering_components.measured_unit |
string | Unit of measurement, for example, GB. |
offering_components.unit_factor |
integer | The conversion factor from backend units to measured_unit |
offering_components.limit_period |
any | |
offering_components.limit_amount |
integer | |
offering_components.article_code |
string | |
offering_components.max_value |
integer | |
offering_components.min_value |
integer | |
offering_components.max_available_limit |
integer | |
offering_components.is_boolean |
boolean | |
offering_components.default_limit |
integer | |
offering_components.factor |
integer | |
offering_components.is_builtin |
boolean | |
offering_components.is_prepaid |
boolean | |
offering_components.overage_component |
string (uuid) | |
offering_components.min_prepaid_duration |
integer | |
offering_components.max_prepaid_duration |
integer |
Other Actions
Add node
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
ManagedRancherCreateNodeRequest - API Source:
managed_rancher_cluster_resources_add_node
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
role |
string | ✓ |
system_volume_size |
integer | |
system_volume_type |
string (uri) | |
memory |
integer | |
cpu |
integer | |
subnet |
string (uri) | ✓ |
flavor |
string (uri) | |
data_volumes |
array of objects | |
data_volumes.size |
integer | ✓ |
data_volumes.volume_type |
string (uri) | |
data_volumes.filesystem |
string | |
data_volumes.mount_point |
string | ✓ |
ssh_public_key |
string (uri) | |
tenant |
string (uri) |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
created |
string (date-time) | |
modified |
string (date-time) | |
name |
string | |
backend_id |
string | |
project_uuid |
string (uuid) | |
service_settings_name |
string | |
service_settings_uuid |
string (uuid) | |
resource_type |
string | |
state |
any | |
cluster |
string (uri) | |
cluster_name |
string | |
cluster_uuid |
string (uuid) | |
instance |
string | |
instance_name |
string | |
instance_uuid |
string (uuid) | |
instance_marketplace_uuid |
string (uuid) | |
role |
string | Enum: agent, server |
k8s_version |
string | |
docker_version |
string | |
cpu_allocated |
number (double) | |
cpu_total |
integer | |
ram_allocated |
integer | Allocated RAM in Mi. |
ram_total |
integer | Total RAM in Mi. |
pods_allocated |
integer | |
pods_total |
integer | |
labels |
any | |
annotations |
any | |
runtime_state |
string |
Rancher Namespaces
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/rancher-namespaces/ |
List Rancher Namespaces |
| GET | /api/rancher-namespaces/{uuid}/ |
Retrieve |
List Rancher Namespaces
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 | |
- Model Source:
RancherNamespaceOEnum - API Source:
rancher_namespaces_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
cluster_uuid |
string (uuid) | |
name |
string | Name |
name_exact |
string | Name (exact) |
o |
array | Ordering |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
project_uuid |
string (uuid) | |
settings |
string (uri) | Settings URL |
settings_uuid |
string (uuid) | Settings UUID |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
created |
string (date-time) |
modified |
string (date-time) |
runtime_state |
string |
project |
string (uri) |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
rancher_namespaces_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
created |
string (date-time) |
modified |
string (date-time) |
runtime_state |
string |
project |
string (uri) |
Rancher Nodes
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/rancher-nodes/ |
List Rancher Nodes |
| GET | /api/rancher-nodes/{uuid}/ |
Retrieve |
| POST | /api/rancher-nodes/ |
Create |
| POST | /api/rancher-nodes/{uuid}/pull/ |
Synchronize resource state |
| POST | /api/rancher-nodes/{uuid}/unlink/ |
Unlink resource |
| POST | /api/rancher-nodes/{uuid}/unlink_openstack/ |
Unlinks node from OpenStack instance |
| DELETE | /api/rancher-nodes/{uuid}/ |
Delete |
| Other Actions | ||
| GET | /api/rancher-nodes/{uuid}/console_log/ |
Returns console log for the node |
| GET | /api/rancher-nodes/{uuid}/console/ |
Returns console URL for the node |
| POST | /api/rancher-nodes/{uuid}/link_openstack/ |
Links node to OpenStack instance |
| POST | /api/rancher-nodes/{uuid}/set_erred/ |
Mark resource as ERRED |
| POST | /api/rancher-nodes/{uuid}/set_ok/ |
Mark resource as OK |
Core CRUD
List Rancher Nodes
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
rancher_nodes_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
cluster_uuid |
string (uuid) | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
created |
string (date-time) | |
modified |
string (date-time) | |
name |
string | |
backend_id |
string | |
project_uuid |
string (uuid) | |
service_settings_name |
string | |
service_settings_uuid |
string (uuid) | |
resource_type |
string | |
state |
any | |
cluster |
string (uri) | |
cluster_name |
string | |
cluster_uuid |
string (uuid) | |
instance |
string | |
instance_name |
string | |
instance_uuid |
string (uuid) | |
instance_marketplace_uuid |
string (uuid) | |
role |
string | Enum: agent, server |
k8s_version |
string | |
docker_version |
string | |
cpu_allocated |
number (double) | |
cpu_total |
integer | |
ram_allocated |
integer | Allocated RAM in Mi. |
ram_total |
integer | Total RAM in Mi. |
pods_allocated |
integer | |
pods_total |
integer | |
labels |
any | |
annotations |
any | |
runtime_state |
string |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
rancher_nodes_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
created |
string (date-time) | |
modified |
string (date-time) | |
name |
string | |
backend_id |
string | |
project_uuid |
string (uuid) | |
service_settings_name |
string | |
service_settings_uuid |
string (uuid) | |
resource_type |
string | |
state |
any | |
cluster |
string (uri) | |
cluster_name |
string | |
cluster_uuid |
string (uuid) | |
instance |
string | |
instance_name |
string | |
instance_uuid |
string (uuid) | |
instance_marketplace_uuid |
string (uuid) | |
role |
string | Enum: agent, server |
k8s_version |
string | |
docker_version |
string | |
cpu_allocated |
number (double) | |
cpu_total |
integer | |
ram_allocated |
integer | Allocated RAM in Mi. |
ram_total |
integer | Total RAM in Mi. |
pods_allocated |
integer | |
pods_total |
integer | |
labels |
any | |
annotations |
any | |
runtime_state |
string |
Create
1 2 3 4 5 6 7 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
RancherCreateNodeRequest - API Source:
rancher_nodes_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
| Field | Type | Required |
|---|---|---|
cluster |
string (uri) | ✓ |
role |
string | ✓ |
system_volume_size |
integer | |
system_volume_type |
string (uri) | |
memory |
integer | |
cpu |
integer | |
subnet |
string (uri) | ✓ |
flavor |
string (uri) | |
data_volumes |
array of objects | |
data_volumes.size |
integer | ✓ |
data_volumes.volume_type |
string (uri) | |
data_volumes.filesystem |
string | |
data_volumes.mount_point |
string | ✓ |
ssh_public_key |
string (uri) | |
tenant |
string (uri) |
201 -
| Field | Type |
|---|---|
cluster |
string (uri) |
role |
string |
uuid |
string (uuid) |
Synchronize resource state
Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
rancher_nodes_pull
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
202 -
| Field | Type |
|---|---|
detail |
string |
409 -
| Field | Type |
|---|---|
detail |
string |
Unlink resource
Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
rancher_nodes_unlink
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Unlinks node from OpenStack instance
Unlinks node from OpenStack instance.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
rancher_nodes_unlink_openstack
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - No response body
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
rancher_nodes_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
Returns console log for the node
Returns console log for the node.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
rancher_nodes_console_log_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type |
|---|---|
length |
integer |
200 -
404 - No response body
Returns console URL for the node
Returns console URL for the node.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
rancher_nodes_console_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
Links node to OpenStack instance
Links node to OpenStack instance.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
LinkOpenstackRequest - API Source:
rancher_nodes_link_openstack
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
instance |
string (uri) | ✓ |
200 - No response body
Mark resource as ERRED
Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
SetErredRequest - API Source:
rancher_nodes_set_erred
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
error_message |
string | |
error_traceback |
string |
200 -
| Field | Type |
|---|---|
detail |
string |
Mark resource as OK
Manually transition the resource to OK state and clear error fields. Staff-only operation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
rancher_nodes_set_ok
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
detail |
string |
Rancher Projects
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/rancher-projects/ |
List Rancher Projects |
| GET | /api/rancher-projects/{uuid}/ |
Retrieve |
| Other Actions | ||
| GET | /api/rancher-projects/{uuid}/secrets/ |
Returns project's secrets |
Core CRUD
List Rancher Projects
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
rancher_projects_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
cluster_uuid |
string (uuid) | |
name |
string | Name |
name_exact |
string | Name (exact) |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
settings |
string (uri) | Settings URL |
settings_uuid |
string (uuid) | Settings UUID |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
description |
string |
created |
string (date-time) |
modified |
string (date-time) |
runtime_state |
string |
cluster |
string (uri) |
namespaces |
array of objects |
namespaces.url |
string (uri) |
namespaces.uuid |
string (uuid) |
namespaces.name |
string |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
rancher_projects_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
description |
string |
created |
string (date-time) |
modified |
string (date-time) |
runtime_state |
string |
cluster |
string (uri) |
namespaces |
array of objects |
namespaces.url |
string (uri) |
namespaces.uuid |
string (uuid) |
namespaces.name |
string |
Other Actions
Returns project's secrets
Returns project's secrets.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
rancher_projects_secrets_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
description |
string |
created |
string (date-time) |
modified |
string (date-time) |
runtime_state |
string |
cluster |
string (uri) |
namespaces |
array of objects |
namespaces.url |
string (uri) |
namespaces.uuid |
string (uuid) |
namespaces.name |
string |
Rancher Role Templates
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/rancher-role-templates/ |
List Rancher Role Templates |
| GET | /api/rancher-role-templates/{uuid}/ |
Retrieve |
List Rancher Role Templates
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 | |
- Model Source:
RoleTemplateOEnum - API Source:
rancher_role_templates_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
name |
string | |
o |
array | Ordering |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
scope_type |
string | |
settings_uuid |
string (uuid) |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | Role internal name |
scope_type |
any | |
display_name |
string | Role public name |
settings |
string (uri) |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
rancher_role_templates_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | Role internal name |
scope_type |
any | |
display_name |
string | Role public name |
settings |
string (uri) |
Rancher Services
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/rancher-services/ |
List Rancher Services |
| GET | /api/rancher-services/{uuid}/ |
Retrieve |
| POST | /api/rancher-services/ |
Create |
| POST | /api/rancher-services/{uuid}/pull/ |
Synchronize resource state |
| POST | /api/rancher-services/{uuid}/unlink/ |
Unlink resource |
| PUT | /api/rancher-services/{uuid}/ |
Update |
| PATCH | /api/rancher-services/{uuid}/ |
Partial Update |
| DELETE | /api/rancher-services/{uuid}/ |
Delete |
| Other Actions | ||
| GET | /api/rancher-services/{uuid}/yaml/ |
Yaml |
| POST | /api/rancher-services/{uuid}/set_erred/ |
Mark resource as ERRED |
| POST | /api/rancher-services/{uuid}/set_ok/ |
Mark resource as OK |
| PUT | /api/rancher-services/{uuid}/yaml/ |
Yaml |
Core CRUD
List Rancher Services
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- Model Source:
CoreStates - Model Source:
RancherServiceFieldEnum - API Source:
rancher_services_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
backend_id |
string | Backend ID |
can_manage |
boolean | Can manage |
cluster_uuid |
string (uuid) | |
customer |
string (uuid) | Customer UUID |
customer_abbreviation |
string | Customer abbreviation |
customer_name |
string | Customer name |
customer_native_name |
string | Customer native name |
customer_uuid |
string (uuid) | Customer UUID |
description |
string | Description |
external_ip |
string | External IP |
field |
array | |
name |
string | Name |
name_exact |
string | Name (exact) |
namespace_uuid |
string (uuid) | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
project |
string (uuid) | Project UUID |
project_name |
string | Project name |
project_uuid |
string (uuid) | Project UUID |
rancher_project_uuid |
string (uuid) | |
service_settings_name |
string | Service settings name |
service_settings_uuid |
string (uuid) | Service settings UUID |
state |
array | State |
uuid |
string (uuid) | UUID |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
runtime_state |
string | |
namespace |
string (uri) | |
namespace_name |
string | |
cluster_ip |
any | An IPv4 or IPv6 address. |
selector |
any | |
target_workloads |
array of objects | |
target_workloads.uuid |
string (uuid) | |
target_workloads.url |
string (uri) | |
target_workloads.name |
string | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
RancherServiceFieldEnum - API Source:
rancher_services_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
runtime_state |
string | |
namespace |
string (uri) | |
namespace_name |
string | |
cluster_ip |
any | An IPv4 or IPv6 address. |
selector |
any | |
target_workloads |
array of objects | |
target_workloads.uuid |
string (uuid) | |
target_workloads.url |
string (uri) | |
target_workloads.name |
string | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Create
1 2 3 4 5 6 7 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
RancherServiceCreateRequest - API Source:
rancher_services_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ✓ | |
description |
string | ||
service_settings |
string (uri) | ✓ | |
project |
string (uri) | ✓ | |
error_message |
string | ||
error_traceback |
string | ||
backend_id |
string | ||
runtime_state |
string | ||
namespace |
string (uri) | ||
cluster_ip |
any | An IPv4 or IPv6 address. | |
selector |
any | ||
target_workloads |
array of objects | ||
target_workloads.url |
string (uri) | ✓ |
201 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
runtime_state |
string | |
namespace |
string (uri) | |
namespace_name |
string | |
cluster_ip |
any | An IPv4 or IPv6 address. |
selector |
any | |
target_workloads |
array of objects | |
target_workloads.url |
string (uri) | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Synchronize resource state
Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
rancher_services_pull
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
202 -
| Field | Type |
|---|---|
detail |
string |
409 -
| Field | Type |
|---|---|
detail |
string |
Unlink resource
Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
rancher_services_unlink
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Update
1 2 3 4 5 6 7 8 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 | |
- Model Source:
RancherServiceRequest - API Source:
rancher_services_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ✓ | |
description |
string | ||
service_settings |
string (uri) | ✓ | |
project |
string (uri) | ✓ | |
error_message |
string | ||
error_traceback |
string | ||
backend_id |
string | ||
runtime_state |
string | ||
namespace |
string (uri) | ||
cluster_ip |
any | An IPv4 or IPv6 address. | |
selector |
any | ||
target_workloads |
array of objects | ✓ | |
target_workloads.name |
string | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
runtime_state |
string | |
namespace |
string (uri) | |
namespace_name |
string | |
cluster_ip |
any | An IPv4 or IPv6 address. |
selector |
any | |
target_workloads |
array of objects | |
target_workloads.uuid |
string (uuid) | |
target_workloads.url |
string (uri) | |
target_workloads.name |
string | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedRancherServiceRequest - API Source:
rancher_services_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ||
description |
string | ||
service_settings |
string (uri) | ||
project |
string (uri) | ||
error_message |
string | ||
error_traceback |
string | ||
backend_id |
string | ||
runtime_state |
string | ||
namespace |
string (uri) | ||
cluster_ip |
any | An IPv4 or IPv6 address. | |
selector |
any | ||
target_workloads |
array of objects | ||
target_workloads.name |
string | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
runtime_state |
string | |
namespace |
string (uri) | |
namespace_name |
string | |
cluster_ip |
any | An IPv4 or IPv6 address. |
selector |
any | |
target_workloads |
array of objects | |
target_workloads.uuid |
string (uuid) | |
target_workloads.url |
string (uri) | |
target_workloads.name |
string | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
rancher_services_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
Yaml
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
RancherServiceFieldEnum - API Source:
rancher_services_yaml_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
runtime_state |
string | |
namespace |
string (uri) | |
namespace_name |
string | |
cluster_ip |
any | An IPv4 or IPv6 address. |
selector |
any | |
target_workloads |
array of objects | |
target_workloads.uuid |
string (uuid) | |
target_workloads.url |
string (uri) | |
target_workloads.name |
string | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Mark resource as ERRED
Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
SetErredRequest - API Source:
rancher_services_set_erred
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
error_message |
string | |
error_traceback |
string |
200 -
| Field | Type |
|---|---|
detail |
string |
Mark resource as OK
Manually transition the resource to OK state and clear error fields. Staff-only operation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
rancher_services_set_ok
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
detail |
string |
Yaml
1 2 3 4 5 6 7 8 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 | |
- Model Source:
RancherServiceRequest - API Source:
rancher_services_yaml_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ✓ | |
description |
string | ||
service_settings |
string (uri) | ✓ | |
project |
string (uri) | ✓ | |
error_message |
string | ||
error_traceback |
string | ||
backend_id |
string | ||
runtime_state |
string | ||
namespace |
string (uri) | ||
cluster_ip |
any | An IPv4 or IPv6 address. | |
selector |
any | ||
target_workloads |
array of objects | ✓ | |
target_workloads.name |
string | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
runtime_state |
string | |
namespace |
string (uri) | |
namespace_name |
string | |
cluster_ip |
any | An IPv4 or IPv6 address. |
selector |
any | |
target_workloads |
array of objects | |
target_workloads.uuid |
string (uuid) | |
target_workloads.url |
string (uri) | |
target_workloads.name |
string | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Rancher Template Versions
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/rancher-template-versions/{template_uuid}/{version}/ |
Retrieve |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- API Source:
rancher_template_versions_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Name | Type | Required |
|---|---|---|
template_uuid |
string | ✓ |
version |
string | ✓ |
200 -
| Field | Type |
|---|---|
readme |
string |
app_readme |
string |
questions |
array of objects |
questions.label |
string |
questions.description |
string |
questions.variable |
string |
questions.required |
boolean |
questions.validate_ |
any |
questions.type |
string |
questions.default |
string |
questions.group |
string |
questions.showIf |
string |
questions.subquestions |
array of objects |
questions.subquestions.label |
string |
questions.subquestions.description |
string |
questions.subquestions.variable |
string |
questions.subquestions.required |
boolean |
questions.subquestions.validate_ |
any |
questions.subquestions.type |
string |
questions.subquestions.default |
string |
questions.subquestions.group |
string |
questions.subquestions.showIf |
string |
questions.showSubquestionIf |
string |
Rancher Templates
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/rancher-templates/ |
List Rancher Templates |
| GET | /api/rancher-templates/{uuid}/ |
Retrieve |
List Rancher Templates
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 | |
- Model Source:
RancherTemplateOEnum - API Source:
rancher_templates_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
catalog_uuid |
string (uuid) | |
cluster_uuid |
string (uuid) | |
name |
string | Name |
name_exact |
string | Name (exact) |
o |
array | Ordering |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
project_uuid |
string (uuid) | |
settings |
string (uri) | Settings URL |
settings_uuid |
string (uuid) | Settings UUID |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
description |
string |
created |
string (date-time) |
modified |
string (date-time) |
runtime_state |
string |
catalog |
string (uri) |
cluster |
string (uri) |
project |
string (uri) |
icon |
string (uri) |
project_url |
string (uri) |
default_version |
string |
catalog_name |
string |
versions |
array of strings |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
rancher_templates_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
description |
string |
created |
string (date-time) |
modified |
string (date-time) |
runtime_state |
string |
catalog |
string (uri) |
cluster |
string (uri) |
project |
string (uri) |
icon |
string (uri) |
project_url |
string (uri) |
default_version |
string |
catalog_name |
string |
versions |
array of strings |
Rancher Users
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/rancher-users/ |
List Rancher Users |
| GET | /api/rancher-users/{uuid}/ |
Retrieve |
List Rancher Users
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
rancher_users_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
cluster_uuid |
string (uuid) | Cluster UUID |
is_active |
boolean | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
settings_uuid |
string (uuid) | |
user_full_name |
string | User full name contains |
user_username |
string | |
user_uuid |
string (uuid) |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
user |
string (uri) | |
cluster_roles |
array of objects | |
cluster_roles.cluster |
string (uri) | |
cluster_roles.role |
string (uri) | |
cluster_roles.cluster_name |
string | |
cluster_roles.cluster_uuid |
string (uuid) | |
project_roles |
array of objects | |
project_roles.project |
string (uri) | |
project_roles.role |
string (uri) | |
project_roles.project_name |
string | |
project_roles.project_uuid |
string (uuid) | |
settings |
string (uri) | |
is_active |
boolean | |
user_name |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
full_name |
string |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
rancher_users_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
user |
string (uri) | |
cluster_roles |
array of objects | |
cluster_roles.cluster |
string (uri) | |
cluster_roles.role |
string (uri) | |
cluster_roles.cluster_name |
string | |
cluster_roles.cluster_uuid |
string (uuid) | |
project_roles |
array of objects | |
project_roles.project |
string (uri) | |
project_roles.role |
string (uri) | |
project_roles.project_name |
string | |
project_roles.project_uuid |
string (uuid) | |
settings |
string (uri) | |
is_active |
boolean | |
user_name |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
full_name |
string |
Rancher Workloads
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/rancher-workloads/ |
List Rancher Workloads |
| GET | /api/rancher-workloads/{uuid}/ |
Retrieve |
| POST | /api/rancher-workloads/ |
Create |
| PUT | /api/rancher-workloads/{uuid}/ |
Update |
| PATCH | /api/rancher-workloads/{uuid}/ |
Partial Update |
| DELETE | /api/rancher-workloads/{uuid}/ |
Delete |
| Other Actions | ||
| GET | /api/rancher-workloads/{uuid}/yaml/ |
Yaml |
| POST | /api/rancher-workloads/{uuid}/redeploy/ |
Redeploy |
| PUT | /api/rancher-workloads/{uuid}/yaml/ |
Yaml |
Core CRUD
List Rancher Workloads
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 | |
- Model Source:
RancherWorkloadOEnum - API Source:
rancher_workloads_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
cluster_uuid |
string (uuid) | |
name |
string | Name |
name_exact |
string | Name (exact) |
namespace_uuid |
string (uuid) | |
o |
array | Ordering |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
project_uuid |
string (uuid) | |
settings |
string (uri) | Settings URL |
settings_uuid |
string (uuid) | Settings UUID |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
created |
string (date-time) |
modified |
string (date-time) |
runtime_state |
string |
cluster |
string (uri) |
cluster_uuid |
string (uuid) |
cluster_name |
string |
project |
string (uri) |
project_uuid |
string (uuid) |
project_name |
string |
namespace |
string (uri) |
namespace_uuid |
string (uuid) |
namespace_name |
string |
scale |
integer |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
rancher_workloads_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
created |
string (date-time) |
modified |
string (date-time) |
runtime_state |
string |
cluster |
string (uri) |
cluster_uuid |
string (uuid) |
cluster_name |
string |
project |
string (uri) |
project_uuid |
string (uuid) |
project_name |
string |
namespace |
string (uri) |
namespace_uuid |
string (uuid) |
namespace_name |
string |
scale |
integer |
Create
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
RancherWorkloadRequest - API Source:
rancher_workloads_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Field | Type | Required |
|---|---|---|
name |
string | ✓ |
runtime_state |
string | |
cluster |
string (uri) | |
project |
string (uri) | |
namespace |
string (uri) | |
scale |
integer | ✓ |
201 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
created |
string (date-time) |
modified |
string (date-time) |
runtime_state |
string |
cluster |
string (uri) |
cluster_uuid |
string (uuid) |
cluster_name |
string |
project |
string (uri) |
project_uuid |
string (uuid) |
project_name |
string |
namespace |
string (uri) |
namespace_uuid |
string (uuid) |
namespace_name |
string |
scale |
integer |
Update
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
RancherWorkloadRequest - API Source:
rancher_workloads_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
name |
string | ✓ |
runtime_state |
string | |
cluster |
string (uri) | |
project |
string (uri) | |
namespace |
string (uri) | |
scale |
integer | ✓ |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
created |
string (date-time) |
modified |
string (date-time) |
runtime_state |
string |
cluster |
string (uri) |
cluster_uuid |
string (uuid) |
cluster_name |
string |
project |
string (uri) |
project_uuid |
string (uuid) |
project_name |
string |
namespace |
string (uri) |
namespace_uuid |
string (uuid) |
namespace_name |
string |
scale |
integer |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedRancherWorkloadRequest - API Source:
rancher_workloads_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
name |
string | |
runtime_state |
string | |
cluster |
string (uri) | |
project |
string (uri) | |
namespace |
string (uri) | |
scale |
integer |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
created |
string (date-time) |
modified |
string (date-time) |
runtime_state |
string |
cluster |
string (uri) |
cluster_uuid |
string (uuid) |
cluster_name |
string |
project |
string (uri) |
project_uuid |
string (uuid) |
project_name |
string |
namespace |
string (uri) |
namespace_uuid |
string (uuid) |
namespace_name |
string |
scale |
integer |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
rancher_workloads_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
Yaml
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
rancher_workloads_yaml_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
created |
string (date-time) |
modified |
string (date-time) |
runtime_state |
string |
cluster |
string (uri) |
cluster_uuid |
string (uuid) |
cluster_name |
string |
project |
string (uri) |
project_uuid |
string (uuid) |
project_name |
string |
namespace |
string (uri) |
namespace_uuid |
string (uuid) |
namespace_name |
string |
scale |
integer |
Redeploy
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
rancher_workloads_redeploy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - No response body
Yaml
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
RancherWorkloadRequest - API Source:
rancher_workloads_yaml_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
name |
string | ✓ |
runtime_state |
string | |
cluster |
string (uri) | |
project |
string (uri) | |
namespace |
string (uri) | |
scale |
integer | ✓ |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
created |
string (date-time) |
modified |
string (date-time) |
runtime_state |
string |
cluster |
string (uri) |
cluster_uuid |
string (uuid) |
cluster_name |
string |
project |
string (uri) |
project_uuid |
string (uuid) |
project_name |
string |
namespace |
string (uri) |
namespace_uuid |
string (uuid) |
namespace_name |
string |
scale |
integer |
Slurm
Slurm Allocation User Usage
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/slurm-allocation-user-usage/ |
List Slurm Allocation User Usage |
| GET | /api/slurm-allocation-user-usage/{id}/ |
Retrieve |
List Slurm Allocation User Usage
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
slurm_allocation_user_usage_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
allocation |
string (uri) | |
allocation_uuid |
string (uuid) | |
month |
integer | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
user |
string (uri) | |
user_uuid |
string (uuid) | |
year |
integer |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
cpu_usage |
integer (int64) |
ram_usage |
integer (int64) |
gpu_usage |
integer (int64) |
month |
integer |
year |
integer |
allocation |
string (uri) |
user |
string (uri) |
username |
string |
full_name |
string |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
slurm_allocation_user_usage_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required | Description |
|---|---|---|---|
id |
integer | ✓ | A unique integer value identifying this allocation user usage. |
200 -
| Field | Type |
|---|---|
cpu_usage |
integer (int64) |
ram_usage |
integer (int64) |
gpu_usage |
integer (int64) |
month |
integer |
year |
integer |
allocation |
string (uri) |
user |
string (uri) |
username |
string |
full_name |
string |
Slurm Allocations
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/slurm-allocations/ |
List Slurm Allocations |
| GET | /api/slurm-allocations/{uuid}/ |
Retrieve |
| POST | /api/slurm-allocations/ |
Create |
| POST | /api/slurm-allocations/{uuid}/pull/ |
Synchronize resource state |
| POST | /api/slurm-allocations/{uuid}/unlink/ |
Unlink resource |
| PUT | /api/slurm-allocations/{uuid}/ |
Update |
| PATCH | /api/slurm-allocations/{uuid}/ |
Partial Update |
| DELETE | /api/slurm-allocations/{uuid}/ |
Delete |
| Other Actions | ||
| POST | /api/slurm-allocations/{uuid}/set_erred/ |
Mark resource as ERRED |
| POST | /api/slurm-allocations/{uuid}/set_limits/ |
Set limits |
| POST | /api/slurm-allocations/{uuid}/set_ok/ |
Mark resource as OK |
Core CRUD
List Slurm Allocations
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- Model Source:
CoreStates - Model Source:
SlurmAllocationFieldEnum - API Source:
slurm_allocations_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
backend_id |
string | Backend ID |
can_manage |
boolean | Can manage |
customer |
string (uuid) | Customer UUID |
customer_abbreviation |
string | Customer abbreviation |
customer_name |
string | Customer name |
customer_native_name |
string | Customer native name |
customer_uuid |
string (uuid) | Customer UUID |
description |
string | Description |
external_ip |
string | External IP |
field |
array | |
is_active |
boolean | |
name |
string | Name |
name_exact |
string | Name (exact) |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
project |
string (uuid) | Project UUID |
project_name |
string | Project name |
project_uuid |
string (uuid) | Project UUID |
service_settings_name |
string | Service settings name |
service_settings_uuid |
string (uuid) | Service settings UUID |
state |
array | State |
uuid |
string (uuid) | UUID |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
description |
string |
service_name |
string |
service_settings |
string (uri) |
service_settings_uuid |
string (uuid) |
service_settings_state |
string |
service_settings_error_message |
string |
project |
string (uri) |
project_name |
string |
project_uuid |
string (uuid) |
customer |
string (uri) |
customer_uuid |
string (uuid) |
customer_name |
string |
customer_native_name |
string |
customer_abbreviation |
string |
error_message |
string |
error_traceback |
string |
resource_type |
string |
state |
any |
created |
string (date-time) |
modified |
string (date-time) |
backend_id |
string |
access_url |
string |
cpu_limit |
integer |
cpu_usage |
integer |
gpu_limit |
integer |
gpu_usage |
integer |
ram_limit |
integer |
ram_usage |
integer |
username |
string |
gateway |
string |
is_active |
boolean |
marketplace_offering_uuid |
string |
marketplace_offering_name |
string |
marketplace_offering_plugin_options |
object (free-form) |
marketplace_category_uuid |
string |
marketplace_category_name |
string |
marketplace_resource_uuid |
string |
marketplace_plan_uuid |
string |
marketplace_resource_state |
string |
is_usage_based |
boolean |
is_limit_based |
boolean |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
SlurmAllocationFieldEnum - API Source:
slurm_allocations_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
description |
string |
service_name |
string |
service_settings |
string (uri) |
service_settings_uuid |
string (uuid) |
service_settings_state |
string |
service_settings_error_message |
string |
project |
string (uri) |
project_name |
string |
project_uuid |
string (uuid) |
customer |
string (uri) |
customer_uuid |
string (uuid) |
customer_name |
string |
customer_native_name |
string |
customer_abbreviation |
string |
error_message |
string |
error_traceback |
string |
resource_type |
string |
state |
any |
created |
string (date-time) |
modified |
string (date-time) |
backend_id |
string |
access_url |
string |
cpu_limit |
integer |
cpu_usage |
integer |
gpu_limit |
integer |
gpu_usage |
integer |
ram_limit |
integer |
ram_usage |
integer |
username |
string |
gateway |
string |
is_active |
boolean |
marketplace_offering_uuid |
string |
marketplace_offering_name |
string |
marketplace_offering_plugin_options |
object (free-form) |
marketplace_category_uuid |
string |
marketplace_category_name |
string |
marketplace_resource_uuid |
string |
marketplace_plan_uuid |
string |
marketplace_resource_state |
string |
is_usage_based |
boolean |
is_limit_based |
boolean |
Create
1 2 3 4 5 6 7 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
SlurmAllocationRequest - API Source:
slurm_allocations_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
| Field | Type | Required |
|---|---|---|
name |
string | ✓ |
description |
string | |
service_settings |
string (uri) | ✓ |
project |
string (uri) | ✓ |
201 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
description |
string |
service_name |
string |
service_settings |
string (uri) |
service_settings_uuid |
string (uuid) |
service_settings_state |
string |
service_settings_error_message |
string |
project |
string (uri) |
project_name |
string |
project_uuid |
string (uuid) |
customer |
string (uri) |
customer_uuid |
string (uuid) |
customer_name |
string |
customer_native_name |
string |
customer_abbreviation |
string |
error_message |
string |
error_traceback |
string |
resource_type |
string |
state |
any |
created |
string (date-time) |
modified |
string (date-time) |
backend_id |
string |
access_url |
string |
cpu_limit |
integer |
cpu_usage |
integer |
gpu_limit |
integer |
gpu_usage |
integer |
ram_limit |
integer |
ram_usage |
integer |
username |
string |
gateway |
string |
is_active |
boolean |
marketplace_offering_uuid |
string |
marketplace_offering_name |
string |
marketplace_offering_plugin_options |
object (free-form) |
marketplace_category_uuid |
string |
marketplace_category_name |
string |
marketplace_resource_uuid |
string |
marketplace_plan_uuid |
string |
marketplace_resource_state |
string |
is_usage_based |
boolean |
is_limit_based |
boolean |
Synchronize resource state
Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
slurm_allocations_pull
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
202 -
| Field | Type |
|---|---|
detail |
string |
409 -
| Field | Type |
|---|---|
detail |
string |
Unlink resource
Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
slurm_allocations_unlink
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Update
1 2 3 4 5 6 7 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | |
- Model Source:
SlurmAllocationRequest - API Source:
slurm_allocations_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
name |
string | ✓ |
description |
string | |
service_settings |
string (uri) | ✓ |
project |
string (uri) | ✓ |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
description |
string |
service_name |
string |
service_settings |
string (uri) |
service_settings_uuid |
string (uuid) |
service_settings_state |
string |
service_settings_error_message |
string |
project |
string (uri) |
project_name |
string |
project_uuid |
string (uuid) |
customer |
string (uri) |
customer_uuid |
string (uuid) |
customer_name |
string |
customer_native_name |
string |
customer_abbreviation |
string |
error_message |
string |
error_traceback |
string |
resource_type |
string |
state |
any |
created |
string (date-time) |
modified |
string (date-time) |
backend_id |
string |
access_url |
string |
cpu_limit |
integer |
cpu_usage |
integer |
gpu_limit |
integer |
gpu_usage |
integer |
ram_limit |
integer |
ram_usage |
integer |
username |
string |
gateway |
string |
is_active |
boolean |
marketplace_offering_uuid |
string |
marketplace_offering_name |
string |
marketplace_offering_plugin_options |
object (free-form) |
marketplace_category_uuid |
string |
marketplace_category_name |
string |
marketplace_resource_uuid |
string |
marketplace_plan_uuid |
string |
marketplace_resource_state |
string |
is_usage_based |
boolean |
is_limit_based |
boolean |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedSlurmAllocationRequest - API Source:
slurm_allocations_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
name |
string | |
description |
string |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
description |
string |
service_name |
string |
service_settings |
string (uri) |
service_settings_uuid |
string (uuid) |
service_settings_state |
string |
service_settings_error_message |
string |
project |
string (uri) |
project_name |
string |
project_uuid |
string (uuid) |
customer |
string (uri) |
customer_uuid |
string (uuid) |
customer_name |
string |
customer_native_name |
string |
customer_abbreviation |
string |
error_message |
string |
error_traceback |
string |
resource_type |
string |
state |
any |
created |
string (date-time) |
modified |
string (date-time) |
backend_id |
string |
access_url |
string |
cpu_limit |
integer |
cpu_usage |
integer |
gpu_limit |
integer |
gpu_usage |
integer |
ram_limit |
integer |
ram_usage |
integer |
username |
string |
gateway |
string |
is_active |
boolean |
marketplace_offering_uuid |
string |
marketplace_offering_name |
string |
marketplace_offering_plugin_options |
object (free-form) |
marketplace_category_uuid |
string |
marketplace_category_name |
string |
marketplace_resource_uuid |
string |
marketplace_plan_uuid |
string |
marketplace_resource_state |
string |
is_usage_based |
boolean |
is_limit_based |
boolean |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
slurm_allocations_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
Mark resource as ERRED
Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
SetErredRequest - API Source:
slurm_allocations_set_erred
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
error_message |
string | |
error_traceback |
string |
200 -
| Field | Type |
|---|---|
detail |
string |
Set limits
1 2 3 4 5 6 7 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | |
- Model Source:
SlurmAllocationSetLimitsRequest - API Source:
slurm_allocations_set_limits
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
cpu_limit |
integer | ✓ |
gpu_limit |
integer | ✓ |
ram_limit |
integer | ✓ |
200 -
| Field | Type |
|---|---|
cpu_limit |
integer |
gpu_limit |
integer |
ram_limit |
integer |
Mark resource as OK
Manually transition the resource to OK state and clear error fields. Staff-only operation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
slurm_allocations_set_ok
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
detail |
string |
Slurm Associations
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/slurm-associations/ |
List Slurm Associations |
| GET | /api/slurm-associations/{uuid}/ |
Retrieve |
List Slurm Associations
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
slurm_associations_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
allocation |
string (uri) | |
allocation_uuid |
string (uuid) | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
uuid |
string (uuid) |
username |
string |
allocation |
string (uri) |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
slurm_associations_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
username |
string |
allocation |
string (uri) |
Slurm Jobs
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/slurm-jobs/ |
List Slurm Jobs |
| GET | /api/slurm-jobs/{uuid}/ |
Retrieve |
| POST | /api/slurm-jobs/ |
Create |
| POST | /api/slurm-jobs/{uuid}/pull/ |
Synchronize resource state |
| POST | /api/slurm-jobs/{uuid}/unlink/ |
Unlink resource |
| PUT | /api/slurm-jobs/{uuid}/ |
Update |
| PATCH | /api/slurm-jobs/{uuid}/ |
Partial Update |
| DELETE | /api/slurm-jobs/{uuid}/ |
Delete |
| Other Actions | ||
| POST | /api/slurm-jobs/{uuid}/set_erred/ |
Mark resource as ERRED |
| POST | /api/slurm-jobs/{uuid}/set_ok/ |
Mark resource as OK |
Core CRUD
List Slurm Jobs
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 | |
- Model Source:
FirecrestJobFieldEnum - API Source:
slurm_jobs_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
field |
array | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
runtime_state |
string | |
file |
string (uri) | |
user |
string (uri) | Reference to user which submitted job |
user_uuid |
string (uuid) | |
user_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
report |
any |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
FirecrestJobFieldEnum - API Source:
slurm_jobs_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
runtime_state |
string | |
file |
string (uri) | |
user |
string (uri) | Reference to user which submitted job |
user_uuid |
string (uuid) | |
user_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
report |
any |
Create
1 2 3 4 5 6 7 8 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | |
- Model Source:
FirecrestJobRequest - API Source:
slurm_jobs_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Field | Type | Required |
|---|---|---|
name |
string | ✓ |
description |
string | |
service_settings |
string (uri) | ✓ |
project |
string (uri) | ✓ |
runtime_state |
string | |
file |
string (binary) | ✓ |
201 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
runtime_state |
string | |
file |
string (uri) | |
user |
string (uri) | Reference to user which submitted job |
user_uuid |
string (uuid) | |
user_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
report |
any |
Synchronize resource state
Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
slurm_jobs_pull
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
202 -
| Field | Type |
|---|---|
detail |
string |
409 -
| Field | Type |
|---|---|
detail |
string |
Unlink resource
Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
slurm_jobs_unlink
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Update
1 2 3 4 5 6 7 8 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 | |
- Model Source:
FirecrestJobRequest - API Source:
slurm_jobs_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
name |
string | ✓ |
description |
string | |
service_settings |
string (uri) | ✓ |
project |
string (uri) | ✓ |
runtime_state |
string | |
file |
string (binary) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
runtime_state |
string | |
file |
string (uri) | |
user |
string (uri) | Reference to user which submitted job |
user_uuid |
string (uuid) | |
user_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
report |
any |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedFirecrestJobRequest - API Source:
slurm_jobs_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
name |
string | |
description |
string | |
runtime_state |
string |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
runtime_state |
string | |
file |
string (uri) | |
user |
string (uri) | Reference to user which submitted job |
user_uuid |
string (uuid) | |
user_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
report |
any |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
slurm_jobs_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
Mark resource as ERRED
Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
SetErredRequest - API Source:
slurm_jobs_set_erred
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
error_message |
string | |
error_traceback |
string |
200 -
| Field | Type |
|---|---|
detail |
string |
Mark resource as OK
Manually transition the resource to OK state and clear error fields. Staff-only operation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
slurm_jobs_set_ok
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
detail |
string |
Marketplace Slurm Periodic Usage Policies
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/marketplace-slurm-periodic-usage-policies/ |
List Marketplace Slurm Periodic Usage Policies |
| GET | /api/marketplace-slurm-periodic-usage-policies/{uuid}/ |
Retrieve |
| POST | /api/marketplace-slurm-periodic-usage-policies/ |
Create |
| PUT | /api/marketplace-slurm-periodic-usage-policies/{uuid}/ |
Update |
| PATCH | /api/marketplace-slurm-periodic-usage-policies/{uuid}/ |
Partial Update |
| DELETE | /api/marketplace-slurm-periodic-usage-policies/{uuid}/ |
Delete |
| Other Actions | ||
| GET | /api/marketplace-slurm-periodic-usage-policies/actions/ |
List Marketplace Slurm Periodic Usage Policies Actions |
| GET | /api/marketplace-slurm-periodic-usage-policies/{uuid}/command-history/ |
List command history for this policy |
| GET | /api/marketplace-slurm-periodic-usage-policies/{uuid}/evaluation-logs/ |
List evaluation logs for this policy |
| POST | /api/marketplace-slurm-periodic-usage-policies/{uuid}/dry-run/ |
Dry run |
| POST | /api/marketplace-slurm-periodic-usage-policies/{uuid}/evaluate/ |
Evaluate |
| POST | /api/marketplace-slurm-periodic-usage-policies/preview_impact/ |
Preview impact |
| POST | /api/marketplace-slurm-periodic-usage-policies/{uuid}/report-command-result/ |
Report command execution result from site agent |
Core CRUD
List Marketplace Slurm Periodic Usage Policies
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
marketplace_slurm_periodic_usage_policies_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
scope |
string (uri) | |
scope_uuid |
string (uuid) |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
scope |
string (uri) | |
scope_name |
string | |
scope_uuid |
string (uuid) | |
actions |
string | |
created |
string (date-time) | |
created_by_full_name |
string | |
created_by_username |
string | |
has_fired |
boolean | |
fired_datetime |
string (date-time) | |
options |
any | Fields for saving actions extra data. Keys are name of actions. |
organization_groups |
array of string (uri)s | |
apply_to_all |
boolean | If True, policy applies to all customers. Mutually exclusive with organization_groups. |
component_limits_set |
array of objects | |
component_limits_set.type |
string | |
component_limits_set.limit |
integer | |
period |
any | |
period_name |
string | |
limit_type |
any | SLURM limit type to apply |
tres_billing_enabled |
boolean | Use TRES billing units instead of raw TRES values |
tres_billing_weights |
any | TRES billing weights (e.g., {"CPU": 0.015625, "Mem": 0.001953125, "GRES/gpu": 0.25}) |
carryover_factor |
integer | Maximum percentage of base allocation that can carry over from unused previous period (0-100) |
grace_ratio |
number (double) | Grace period ratio (0.2 = 20% overconsumption allowed) |
carryover_enabled |
boolean | Enable unused allocation carryover to next period |
raw_usage_reset |
boolean | Reset raw usage at period transitions (PriorityUsageResetPeriod=None) |
qos_strategy |
any | QoS management strategy |
warnings |
array of strings | Warnings about misconfiguration, e.g. missing site agent queue registration. |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
scope |
string (uri) | |
scope_name |
string | |
scope_uuid |
string (uuid) | |
actions |
string | |
created |
string (date-time) | |
created_by_full_name |
string | |
created_by_username |
string | |
has_fired |
boolean | |
fired_datetime |
string (date-time) | |
options |
any | Fields for saving actions extra data. Keys are name of actions. |
organization_groups |
array of string (uri)s | |
apply_to_all |
boolean | If True, policy applies to all customers. Mutually exclusive with organization_groups. |
component_limits_set |
array of objects | |
component_limits_set.type |
string | |
component_limits_set.limit |
integer | |
period |
any | |
period_name |
string | |
limit_type |
any | SLURM limit type to apply |
tres_billing_enabled |
boolean | Use TRES billing units instead of raw TRES values |
tres_billing_weights |
any | TRES billing weights (e.g., {"CPU": 0.015625, "Mem": 0.001953125, "GRES/gpu": 0.25}) |
carryover_factor |
integer | Maximum percentage of base allocation that can carry over from unused previous period (0-100) |
grace_ratio |
number (double) | Grace period ratio (0.2 = 20% overconsumption allowed) |
carryover_enabled |
boolean | Enable unused allocation carryover to next period |
raw_usage_reset |
boolean | Reset raw usage at period transitions (PriorityUsageResetPeriod=None) |
qos_strategy |
any | QoS management strategy |
warnings |
array of strings | Warnings about misconfiguration, e.g. missing site agent queue registration. |
Create
1 2 3 4 5 6 7 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
SlurmPeriodicUsagePolicyRequest - API Source:
marketplace_slurm_periodic_usage_policies_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
| Field | Type | Required | Description |
|---|---|---|---|
scope |
string (uri) | ✓ | |
actions |
string | ✓ | |
options |
any | Fields for saving actions extra data. Keys are name of actions. | |
organization_groups |
array of string (uri)s | ||
apply_to_all |
boolean | If True, policy applies to all customers. Mutually exclusive with organization_groups. | |
component_limits_set |
array of objects | ✓ | |
component_limits_set.type |
string | ✓ | |
component_limits_set.limit |
integer | ✓ | |
period |
any | ||
limit_type |
any | SLURM limit type to apply | |
tres_billing_enabled |
boolean | Use TRES billing units instead of raw TRES values | |
tres_billing_weights |
any | TRES billing weights (e.g., {"CPU": 0.015625, "Mem": 0.001953125, "GRES/gpu": 0.25}) | |
carryover_factor |
integer | Maximum percentage of base allocation that can carry over from unused previous period (0-100) | |
grace_ratio |
number (double) | Grace period ratio (0.2 = 20% overconsumption allowed) | |
carryover_enabled |
boolean | Enable unused allocation carryover to next period | |
raw_usage_reset |
boolean | Reset raw usage at period transitions (PriorityUsageResetPeriod=None) | |
qos_strategy |
any | QoS management strategy |
201 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
scope |
string (uri) | |
scope_name |
string | |
scope_uuid |
string (uuid) | |
actions |
string | |
created |
string (date-time) | |
created_by_full_name |
string | |
created_by_username |
string | |
has_fired |
boolean | |
fired_datetime |
string (date-time) | |
options |
any | Fields for saving actions extra data. Keys are name of actions. |
organization_groups |
array of string (uri)s | |
apply_to_all |
boolean | If True, policy applies to all customers. Mutually exclusive with organization_groups. |
component_limits_set |
array of objects | |
component_limits_set.type |
string | |
component_limits_set.limit |
integer | |
period |
any | |
period_name |
string | |
limit_type |
any | SLURM limit type to apply |
tres_billing_enabled |
boolean | Use TRES billing units instead of raw TRES values |
tres_billing_weights |
any | TRES billing weights (e.g., {"CPU": 0.015625, "Mem": 0.001953125, "GRES/gpu": 0.25}) |
carryover_factor |
integer | Maximum percentage of base allocation that can carry over from unused previous period (0-100) |
grace_ratio |
number (double) | Grace period ratio (0.2 = 20% overconsumption allowed) |
carryover_enabled |
boolean | Enable unused allocation carryover to next period |
raw_usage_reset |
boolean | Reset raw usage at period transitions (PriorityUsageResetPeriod=None) |
qos_strategy |
any | QoS management strategy |
warnings |
array of strings | Warnings about misconfiguration, e.g. missing site agent queue registration. |
Update
1 2 3 4 5 6 7 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | |
- Model Source:
SlurmPeriodicUsagePolicyRequest - API Source:
marketplace_slurm_periodic_usage_policies_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
scope |
string (uri) | ✓ | |
actions |
string | ✓ | |
options |
any | Fields for saving actions extra data. Keys are name of actions. | |
organization_groups |
array of string (uri)s | ||
apply_to_all |
boolean | If True, policy applies to all customers. Mutually exclusive with organization_groups. | |
component_limits_set |
array of objects | ✓ | |
component_limits_set.type |
string | ✓ | |
component_limits_set.limit |
integer | ✓ | |
period |
any | ||
limit_type |
any | SLURM limit type to apply | |
tres_billing_enabled |
boolean | Use TRES billing units instead of raw TRES values | |
tres_billing_weights |
any | TRES billing weights (e.g., {"CPU": 0.015625, "Mem": 0.001953125, "GRES/gpu": 0.25}) | |
carryover_factor |
integer | Maximum percentage of base allocation that can carry over from unused previous period (0-100) | |
grace_ratio |
number (double) | Grace period ratio (0.2 = 20% overconsumption allowed) | |
carryover_enabled |
boolean | Enable unused allocation carryover to next period | |
raw_usage_reset |
boolean | Reset raw usage at period transitions (PriorityUsageResetPeriod=None) | |
qos_strategy |
any | QoS management strategy |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
scope |
string (uri) | |
scope_name |
string | |
scope_uuid |
string (uuid) | |
actions |
string | |
created |
string (date-time) | |
created_by_full_name |
string | |
created_by_username |
string | |
has_fired |
boolean | |
fired_datetime |
string (date-time) | |
options |
any | Fields for saving actions extra data. Keys are name of actions. |
organization_groups |
array of string (uri)s | |
apply_to_all |
boolean | If True, policy applies to all customers. Mutually exclusive with organization_groups. |
component_limits_set |
array of objects | |
component_limits_set.type |
string | |
component_limits_set.limit |
integer | |
period |
any | |
period_name |
string | |
limit_type |
any | SLURM limit type to apply |
tres_billing_enabled |
boolean | Use TRES billing units instead of raw TRES values |
tres_billing_weights |
any | TRES billing weights (e.g., {"CPU": 0.015625, "Mem": 0.001953125, "GRES/gpu": 0.25}) |
carryover_factor |
integer | Maximum percentage of base allocation that can carry over from unused previous period (0-100) |
grace_ratio |
number (double) | Grace period ratio (0.2 = 20% overconsumption allowed) |
carryover_enabled |
boolean | Enable unused allocation carryover to next period |
raw_usage_reset |
boolean | Reset raw usage at period transitions (PriorityUsageResetPeriod=None) |
qos_strategy |
any | QoS management strategy |
warnings |
array of strings | Warnings about misconfiguration, e.g. missing site agent queue registration. |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedSlurmPeriodicUsagePolicyRequest - API Source:
marketplace_slurm_periodic_usage_policies_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
scope |
string (uri) | ||
actions |
string | ||
options |
any | Fields for saving actions extra data. Keys are name of actions. | |
organization_groups |
array of string (uri)s | ||
apply_to_all |
boolean | If True, policy applies to all customers. Mutually exclusive with organization_groups. | |
component_limits_set |
array of objects | ||
component_limits_set.type |
string | ✓ | |
component_limits_set.limit |
integer | ✓ | |
period |
any | ||
limit_type |
any | SLURM limit type to apply | |
tres_billing_enabled |
boolean | Use TRES billing units instead of raw TRES values | |
tres_billing_weights |
any | TRES billing weights (e.g., {"CPU": 0.015625, "Mem": 0.001953125, "GRES/gpu": 0.25}) | |
carryover_factor |
integer | Maximum percentage of base allocation that can carry over from unused previous period (0-100) | |
grace_ratio |
number (double) | Grace period ratio (0.2 = 20% overconsumption allowed) | |
carryover_enabled |
boolean | Enable unused allocation carryover to next period | |
raw_usage_reset |
boolean | Reset raw usage at period transitions (PriorityUsageResetPeriod=None) | |
qos_strategy |
any | QoS management strategy |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
scope |
string (uri) | |
scope_name |
string | |
scope_uuid |
string (uuid) | |
actions |
string | |
created |
string (date-time) | |
created_by_full_name |
string | |
created_by_username |
string | |
has_fired |
boolean | |
fired_datetime |
string (date-time) | |
options |
any | Fields for saving actions extra data. Keys are name of actions. |
organization_groups |
array of string (uri)s | |
apply_to_all |
boolean | If True, policy applies to all customers. Mutually exclusive with organization_groups. |
component_limits_set |
array of objects | |
component_limits_set.type |
string | |
component_limits_set.limit |
integer | |
period |
any | |
period_name |
string | |
limit_type |
any | SLURM limit type to apply |
tres_billing_enabled |
boolean | Use TRES billing units instead of raw TRES values |
tres_billing_weights |
any | TRES billing weights (e.g., {"CPU": 0.015625, "Mem": 0.001953125, "GRES/gpu": 0.25}) |
carryover_factor |
integer | Maximum percentage of base allocation that can carry over from unused previous period (0-100) |
grace_ratio |
number (double) | Grace period ratio (0.2 = 20% overconsumption allowed) |
carryover_enabled |
boolean | Enable unused allocation carryover to next period |
raw_usage_reset |
boolean | Reset raw usage at period transitions (PriorityUsageResetPeriod=None) |
qos_strategy |
any | QoS management strategy |
warnings |
array of strings | Warnings about misconfiguration, e.g. missing site agent queue registration. |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
List Marketplace Slurm Periodic Usage Policies Actions
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
1 2 3 4 5 6 7 8 9 10 | |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
scope |
string (uri) | |
scope_name |
string | |
scope_uuid |
string (uuid) | |
actions |
string | |
created |
string (date-time) | |
created_by_full_name |
string | |
created_by_username |
string | |
has_fired |
boolean | |
fired_datetime |
string (date-time) | |
options |
any | Fields for saving actions extra data. Keys are name of actions. |
organization_groups |
array of string (uri)s | |
apply_to_all |
boolean | If True, policy applies to all customers. Mutually exclusive with organization_groups. |
component_limits_set |
array of objects | |
component_limits_set.type |
string | |
component_limits_set.limit |
integer | |
period |
any | |
period_name |
string | |
limit_type |
any | SLURM limit type to apply |
tres_billing_enabled |
boolean | Use TRES billing units instead of raw TRES values |
tres_billing_weights |
any | TRES billing weights (e.g., {"CPU": 0.015625, "Mem": 0.001953125, "GRES/gpu": 0.25}) |
carryover_factor |
integer | Maximum percentage of base allocation that can carry over from unused previous period (0-100) |
grace_ratio |
number (double) | Grace period ratio (0.2 = 20% overconsumption allowed) |
carryover_enabled |
boolean | Enable unused allocation carryover to next period |
raw_usage_reset |
boolean | Reset raw usage at period transitions (PriorityUsageResetPeriod=None) |
qos_strategy |
any | QoS management strategy |
warnings |
array of strings | Warnings about misconfiguration, e.g. missing site agent queue registration. |
List command history for this policy
List command history for this policy.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
scope |
string (uri) | |
scope_uuid |
string (uuid) |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
command_type |
string | Type of command: fairshare, limits, qos, reset_usage |
description |
string | Human-readable description of what the command does |
shell_command |
string | Actual shell command that was/would be executed |
parameters |
any | Command parameters as key-value pairs |
executed_at |
string (date-time) | |
execution_mode |
any | Whether command was executed in production or emulator mode |
success |
boolean | Whether the command execution was successful |
error_message |
string | Error message if command execution failed |
List evaluation logs for this policy
List evaluation logs for this policy.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
scope |
string (uri) | |
scope_uuid |
string (uuid) |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
resource_uuid |
string (uuid) | |
resource_name |
string | |
billing_period |
string | Billing period identifier, e.g. '2026-Q1' |
usage_percentage |
number (double) | Resource usage percentage at the time of evaluation |
grace_limit_percentage |
number (double) | Grace limit percentage threshold (e.g. 120 for 20% grace) |
actions_taken |
any | List of actions taken during this evaluation (e.g. ['pause', 'notify']) |
previous_state |
any | Resource state before evaluation: |
new_state |
any | Resource state after evaluation: |
stomp_message_sent |
boolean | Whether a STOMP message was sent to the site agent |
site_agent_confirmed |
boolean | Whether the site agent confirmed command execution (null = no response yet) |
site_agent_response |
any | Response payload from the site agent |
evaluated_at |
string (date-time) | When this evaluation was performed |
Dry run
Staff-only. Dry-run evaluation: calculates usage percentages and shows what actions would be triggered, without applying any changes.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
SlurmPolicyEvaluateRequestRequest - API Source:
marketplace_slurm_periodic_usage_policies_dry_run
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
resource_uuid |
string (uuid) | Evaluate a specific resource. If omitted, evaluates all offering resources. |
200 -
| Field | Type |
|---|---|
policy_uuid |
string (uuid) |
billing_period |
string |
grace_limit_percentage |
number (double) |
resources |
array of objects |
resources.resource_uuid |
string (uuid) |
resources.resource_name |
string |
resources.usage_percentage |
number (double) |
resources.paused |
boolean |
resources.downscaled |
boolean |
resources.would_trigger |
array of strings |
Evaluate
Staff-only. Run synchronous policy evaluation: calculates usage, applies actions (pause/downscale/notify), and creates evaluation logs.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
SlurmPolicyEvaluateRequestRequest - API Source:
marketplace_slurm_periodic_usage_policies_evaluate
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
resource_uuid |
string (uuid) | Evaluate a specific resource. If omitted, evaluates all offering resources. |
200 -
| Field | Type |
|---|---|
policy_uuid |
string (uuid) |
billing_period |
string |
resources |
array of objects |
resources.resource_uuid |
string (uuid) |
resources.resource_name |
string |
resources.usage_percentage |
number (double) |
resources.actions_taken |
array of strings |
resources.previous_state |
object (free-form) |
resources.new_state |
object (free-form) |
Preview impact
Preview policy impact without saving. Returns threshold calculations, carryover projections, and QoS trigger points.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
- Model Source:
SlurmPolicyPreviewRequestRequest - API Source:
marketplace_slurm_periodic_usage_policies_preview_impact
1 2 3 4 5 6 7 8 9 10 | |
| Field | Type | Required | Description |
|---|---|---|---|
allocation |
number (double) | Base allocation for the period (in node-hours or billing units) Constraints: default: 1000.0 |
|
grace_ratio |
number (double) | Grace ratio for overconsumption allowance (0.2 = 20%) Constraints: default: 0.2 |
|
previous_usage |
number (double) | Usage from the previous period Constraints: default: 0.0 |
|
carryover_factor |
integer | Maximum percentage of base allocation that can carry over (0-100) Constraints: default: 50 |
|
carryover_enabled |
boolean | Whether unused allocation carries over to next period Constraints: default: True |
|
resource_uuid |
string (uuid) | Optional resource UUID to use for current usage data | |
current_usage |
number (double) | Current usage in this period (manual input or from resource) Constraints: default: 0.0 |
|
daily_usage_rate |
number (double) | Average daily usage rate for projections Constraints: default: 0.0 |
200 -
| Field | Type | Description |
|---|---|---|
base_allocation |
number (double) | |
effective_allocation |
number (double) | |
carryover_enabled |
boolean | |
carryover |
any | |
thresholds |
object | |
thresholds.allocation |
number (double) | |
thresholds.grace_ratio |
number (double) | |
thresholds.notification_ratio |
number (double) | |
thresholds.notification_threshold |
number (double) | |
thresholds.slowdown_threshold |
number (double) | |
thresholds.blocked_threshold |
number (double) | |
grace_ratio |
number (double) | |
carryover_factor |
integer | |
current_usage |
number (double) | |
daily_usage_rate |
number (double) | |
usage_percentage |
number (double) | |
current_qos_status |
string | Enum: normal, notification, slowdown, blocked |
date_projections |
object | |
date_projections.notification |
object | |
date_projections.notification.days |
integer | |
date_projections.notification.date |
string (date) | |
date_projections.notification.status |
string | Enum: never, exceeded, projected |
date_projections.slowdown |
object | |
date_projections.slowdown.days |
integer | |
date_projections.slowdown.date |
string (date) | |
date_projections.slowdown.status |
string | Enum: never, exceeded, projected |
date_projections.blocked |
object | |
date_projections.blocked.days |
integer | |
date_projections.blocked.date |
string (date) | |
date_projections.blocked.status |
string | Enum: never, exceeded, projected |
preview_commands |
array of objects | |
preview_commands.type |
string | Command type: fairshare, limits, qos, reset_usage |
preview_commands.description |
string | Human-readable description |
preview_commands.command |
string | Actual shell command |
preview_commands.parameters |
object (free-form) | Command parameters |
command_history |
array of objects | |
command_history.uuid |
string (uuid) | |
command_history.command_type |
string | Type of command: fairshare, limits, qos, reset_usage |
command_history.description |
string | Human-readable description of what the command does |
command_history.shell_command |
string | Actual shell command that was/would be executed |
command_history.parameters |
any | Command parameters as key-value pairs |
command_history.executed_at |
string (date-time) | |
command_history.execution_mode |
any | Whether command was executed in production or emulator mode |
command_history.success |
boolean | Whether the command execution was successful |
command_history.error_message |
string | Error message if command execution failed |
billing_period_start |
string (date) | |
billing_period_end |
string (date) |
Report command execution result from site agent
Report command execution result from site agent.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
SlurmCommandResultRequest - API Source:
marketplace_slurm_periodic_usage_policies_report_command_result
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
resource_uuid |
string (uuid) | ✓ | UUID of the resource the command was applied to |
success |
boolean | ✓ | Whether the command was applied successfully |
error_message |
string | Error message if the command failed Constraints: default: `` |
|
mode |
any | Execution mode of the command Constraints: default: production |
|
commands_executed |
array of strings | List of shell commands actually executed by the site agent |
200 - No response body
Vmware
Vmware Clusters
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/vmware-clusters/ |
List Vmware Clusters |
| GET | /api/vmware-clusters/{uuid}/ |
Retrieve |
List Vmware Clusters
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
vmware_clusters_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
customer_uuid |
string (uuid) | Customer UUID |
name |
string | Name |
name_exact |
string | Name (exact) |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
settings |
string (uri) | Settings URL |
settings_uuid |
string (uuid) | Settings UUID |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
vmware_clusters_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
Vmware Datastores
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/vmware-datastores/ |
List Vmware Datastores |
| GET | /api/vmware-datastores/{uuid}/ |
Retrieve |
List Vmware Datastores
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
vmware_datastores_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
customer_uuid |
string (uuid) | Customer UUID |
name |
string | Name |
name_exact |
string | Name (exact) |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
settings |
string (uri) | Settings URL |
settings_uuid |
string (uuid) | Settings UUID |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
type |
string | |
capacity |
integer | Capacity, in MB. |
free_space |
integer | Available space, in MB. |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
vmware_datastores_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
type |
string | |
capacity |
integer | Capacity, in MB. |
free_space |
integer | Available space, in MB. |
Vmware Disks
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/vmware-disks/ |
List Vmware Disks |
| GET | /api/vmware-disks/{uuid}/ |
Retrieve |
| POST | /api/vmware-disks/{uuid}/pull/ |
Synchronize resource state |
| POST | /api/vmware-disks/{uuid}/unlink/ |
Unlink resource |
| DELETE | /api/vmware-disks/{uuid}/ |
Delete |
| Other Actions | ||
| POST | /api/vmware-disks/{uuid}/extend/ |
Increase disk capacity |
| POST | /api/vmware-disks/{uuid}/set_erred/ |
Mark resource as ERRED |
| POST | /api/vmware-disks/{uuid}/set_ok/ |
Mark resource as OK |
Core CRUD
List Vmware Disks
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- Model Source:
CoreStates - Model Source:
VmwareDiskFieldEnum - API Source:
vmware_disks_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
backend_id |
string | Backend ID |
can_manage |
boolean | Can manage |
customer |
string (uuid) | Customer UUID |
customer_abbreviation |
string | Customer abbreviation |
customer_name |
string | Customer name |
customer_native_name |
string | Customer native name |
customer_uuid |
string (uuid) | Customer UUID |
description |
string | Description |
external_ip |
string | External IP |
field |
array | |
name |
string | Name |
name_exact |
string | Name (exact) |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
project |
string (uuid) | Project UUID |
project_name |
string | Project name |
project_uuid |
string (uuid) | Project UUID |
service_settings_name |
string | Service settings name |
service_settings_uuid |
string (uuid) | Service settings UUID |
state |
array | State |
uuid |
string (uuid) | UUID |
vm |
string (uri) | |
vm_uuid |
string (uuid) |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
size |
integer | Size in MiB |
vm |
string (uri) | |
vm_uuid |
string (uuid) | |
vm_name |
string | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
VmwareDiskFieldEnum - API Source:
vmware_disks_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
size |
integer | Size in MiB |
vm |
string (uri) | |
vm_uuid |
string (uuid) | |
vm_name |
string | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Synchronize resource state
Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
vmware_disks_pull
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
202 -
| Field | Type |
|---|---|
detail |
string |
409 -
| Field | Type |
|---|---|
detail |
string |
Unlink resource
Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
vmware_disks_unlink
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
vmware_disks_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
Increase disk capacity
Increase disk capacity
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
VmwareDiskExtendRequest - API Source:
vmware_disks_extend
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
size |
integer | ✓ | Size in MiB |
200 -
| Field | Type | Description |
|---|---|---|
size |
integer | Size in MiB |
Mark resource as ERRED
Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
SetErredRequest - API Source:
vmware_disks_set_erred
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
error_message |
string | |
error_traceback |
string |
200 -
| Field | Type |
|---|---|
detail |
string |
Mark resource as OK
Manually transition the resource to OK state and clear error fields. Staff-only operation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
vmware_disks_set_ok
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
detail |
string |
Vmware Folders
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/vmware-folders/ |
List Vmware Folders |
| GET | /api/vmware-folders/{uuid}/ |
Retrieve |
List Vmware Folders
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
vmware_folders_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
customer_uuid |
string (uuid) | Customer UUID |
name |
string | Name |
name_exact |
string | Name (exact) |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
settings |
string (uri) | Settings URL |
settings_uuid |
string (uuid) | Settings UUID |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
vmware_folders_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
Vmware Limits
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/vmware-limits/{uuid}/ |
Retrieve |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
vmware_limits_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
max_cpu |
integer |
max_cores_per_socket |
integer |
max_ram |
integer |
max_disk |
integer |
max_disk_total |
integer |
Vmware Networks
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/vmware-networks/ |
List Vmware Networks |
| GET | /api/vmware-networks/{uuid}/ |
Retrieve |
List Vmware Networks
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
vmware_networks_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
customer_pair_uuid |
string (uuid) | Customer UUID |
customer_uuid |
string (uuid) | Customer UUID |
name |
string | Name |
name_exact |
string | Name (exact) |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
settings |
string (uri) | Settings URL |
settings_uuid |
string (uuid) | Settings UUID |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
type |
string |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
vmware_networks_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
type |
string |
Vmware Ports
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/vmware-ports/ |
List Vmware Ports |
| GET | /api/vmware-ports/{uuid}/ |
Retrieve |
| POST | /api/vmware-ports/{uuid}/pull/ |
Synchronize resource state |
| POST | /api/vmware-ports/{uuid}/unlink/ |
Unlink resource |
| DELETE | /api/vmware-ports/{uuid}/ |
Delete |
| Other Actions | ||
| POST | /api/vmware-ports/{uuid}/set_erred/ |
Mark resource as ERRED |
| POST | /api/vmware-ports/{uuid}/set_ok/ |
Mark resource as OK |
Core CRUD
List Vmware Ports
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- Model Source:
CoreStates - Model Source:
VmwarePortFieldEnum - API Source:
vmware_ports_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
backend_id |
string | Backend ID |
can_manage |
boolean | Can manage |
customer |
string (uuid) | Customer UUID |
customer_abbreviation |
string | Customer abbreviation |
customer_name |
string | Customer name |
customer_native_name |
string | Customer native name |
customer_uuid |
string (uuid) | Customer UUID |
description |
string | Description |
external_ip |
string | External IP |
field |
array | |
name |
string | Name |
name_exact |
string | Name (exact) |
network |
string (uri) | |
network_uuid |
string (uuid) | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
project |
string (uuid) | Project UUID |
project_name |
string | Project name |
project_uuid |
string (uuid) | Project UUID |
service_settings_name |
string | Service settings name |
service_settings_uuid |
string (uuid) | Service settings UUID |
state |
array | State |
uuid |
string (uuid) | UUID |
vm |
string (uri) | |
vm_uuid |
string (uuid) |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
description |
string |
service_name |
string |
service_settings |
string (uri) |
service_settings_uuid |
string (uuid) |
service_settings_state |
string |
service_settings_error_message |
string |
project |
string (uri) |
project_name |
string |
project_uuid |
string (uuid) |
customer |
string (uri) |
customer_uuid |
string (uuid) |
customer_name |
string |
customer_native_name |
string |
customer_abbreviation |
string |
error_message |
string |
error_traceback |
string |
resource_type |
string |
state |
any |
created |
string (date-time) |
modified |
string (date-time) |
backend_id |
string |
access_url |
string |
mac_address |
string |
vm |
string (uri) |
vm_uuid |
string (uuid) |
vm_name |
string |
network |
string (uri) |
network_name |
string |
marketplace_offering_uuid |
string |
marketplace_offering_name |
string |
marketplace_offering_plugin_options |
object (free-form) |
marketplace_category_uuid |
string |
marketplace_category_name |
string |
marketplace_resource_uuid |
string |
marketplace_plan_uuid |
string |
marketplace_resource_state |
string |
is_usage_based |
boolean |
is_limit_based |
boolean |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
VmwarePortFieldEnum - API Source:
vmware_ports_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
description |
string |
service_name |
string |
service_settings |
string (uri) |
service_settings_uuid |
string (uuid) |
service_settings_state |
string |
service_settings_error_message |
string |
project |
string (uri) |
project_name |
string |
project_uuid |
string (uuid) |
customer |
string (uri) |
customer_uuid |
string (uuid) |
customer_name |
string |
customer_native_name |
string |
customer_abbreviation |
string |
error_message |
string |
error_traceback |
string |
resource_type |
string |
state |
any |
created |
string (date-time) |
modified |
string (date-time) |
backend_id |
string |
access_url |
string |
mac_address |
string |
vm |
string (uri) |
vm_uuid |
string (uuid) |
vm_name |
string |
network |
string (uri) |
network_name |
string |
marketplace_offering_uuid |
string |
marketplace_offering_name |
string |
marketplace_offering_plugin_options |
object (free-form) |
marketplace_category_uuid |
string |
marketplace_category_name |
string |
marketplace_resource_uuid |
string |
marketplace_plan_uuid |
string |
marketplace_resource_state |
string |
is_usage_based |
boolean |
is_limit_based |
boolean |
Synchronize resource state
Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
vmware_ports_pull
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
202 -
| Field | Type |
|---|---|
detail |
string |
409 -
| Field | Type |
|---|---|
detail |
string |
Unlink resource
Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
vmware_ports_unlink
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
vmware_ports_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
Mark resource as ERRED
Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
SetErredRequest - API Source:
vmware_ports_set_erred
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
error_message |
string | |
error_traceback |
string |
200 -
| Field | Type |
|---|---|
detail |
string |
Mark resource as OK
Manually transition the resource to OK state and clear error fields. Staff-only operation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
vmware_ports_set_ok
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
detail |
string |
Vmware Templates
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/vmware-templates/ |
List Vmware Templates |
| GET | /api/vmware-templates/{uuid}/ |
Retrieve |
List Vmware Templates
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
vmware_templates_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
name |
string | Name |
name_exact |
string | Name (exact) |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
settings |
string (uri) | Settings URL |
settings_uuid |
string (uuid) | Settings UUID |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
created |
string (date-time) | |
modified |
string (date-time) | |
guest_os |
string | Defines the valid guest operating system types used for configuring a virtual machine |
guest_os_name |
string | |
cores |
integer | Number of cores in a VM |
cores_per_socket |
integer | Number of cores per socket in a VM |
ram |
integer | Memory size in MiB |
disk |
integer | Disk size in MiB |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
vmware_templates_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
created |
string (date-time) | |
modified |
string (date-time) | |
guest_os |
string | Defines the valid guest operating system types used for configuring a virtual machine |
guest_os_name |
string | |
cores |
integer | Number of cores in a VM |
cores_per_socket |
integer | Number of cores per socket in a VM |
ram |
integer | Memory size in MiB |
disk |
integer | Disk size in MiB |
Vmware Virtual Machine
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/vmware-virtual-machine/ |
List Vmware Virtual Machine |
| GET | /api/vmware-virtual-machine/{uuid}/ |
Retrieve |
| POST | /api/vmware-virtual-machine/ |
Create |
| POST | /api/vmware-virtual-machine/{uuid}/create_disk/ |
Create disk |
| POST | /api/vmware-virtual-machine/{uuid}/create_port/ |
Create port |
| POST | /api/vmware-virtual-machine/{uuid}/pull/ |
Synchronize resource state |
| POST | /api/vmware-virtual-machine/{uuid}/unlink/ |
Unlink resource |
| PUT | /api/vmware-virtual-machine/{uuid}/ |
Update |
| PATCH | /api/vmware-virtual-machine/{uuid}/ |
Partial Update |
| DELETE | /api/vmware-virtual-machine/{uuid}/ |
Delete |
| Other Actions | ||
| GET | /api/vmware-virtual-machine/{uuid}/console/ |
This endpoint provides access to Virtual Machine Remote Console aka VMRC |
| GET | /api/vmware-virtual-machine/{uuid}/web_console/ |
This endpoint provides access to HTML Console aka WMKS |
| POST | /api/vmware-virtual-machine/{uuid}/reboot_guest/ |
Reboot guest |
| POST | /api/vmware-virtual-machine/{uuid}/reset/ |
Reset |
| POST | /api/vmware-virtual-machine/{uuid}/set_erred/ |
Mark resource as ERRED |
| POST | /api/vmware-virtual-machine/{uuid}/set_ok/ |
Mark resource as OK |
| POST | /api/vmware-virtual-machine/{uuid}/shutdown_guest/ |
Shutdown guest |
| POST | /api/vmware-virtual-machine/{uuid}/start/ |
Start |
| POST | /api/vmware-virtual-machine/{uuid}/stop/ |
Stop |
| POST | /api/vmware-virtual-machine/{uuid}/suspend/ |
Suspend |
Core CRUD
List Vmware Virtual Machine
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- Model Source:
CoreStates - Model Source:
VmwareVirtualMachineFieldEnum - API Source:
vmware_virtual_machine_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
backend_id |
string | Backend ID |
can_manage |
boolean | Can manage |
customer |
string (uuid) | Customer UUID |
customer_abbreviation |
string | Customer abbreviation |
customer_name |
string | Customer name |
customer_native_name |
string | Customer native name |
customer_uuid |
string (uuid) | Customer UUID |
description |
string | Description |
external_ip |
string | External IP |
field |
array | |
name |
string | Name |
name_exact |
string | Name (exact) |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
project |
string (uuid) | Project UUID |
project_name |
string | Project name |
project_uuid |
string (uuid) | Project UUID |
runtime_state |
string | |
service_settings_name |
string | Service settings name |
service_settings_uuid |
string (uuid) | Service settings UUID |
state |
array | State |
uuid |
string (uuid) | UUID |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
guest_os |
any | |
guest_os_name |
string | |
cores |
integer | Number of cores in a VM |
cores_per_socket |
integer | Number of cores per socket in a VM |
ram |
integer | Memory size in MiB |
disk |
integer | Disk size in MiB |
disks |
array of objects | |
disks.url |
string (uri) | |
disks.uuid |
string (uuid) | |
disks.size |
integer | Size in MiB |
runtime_state |
string | |
cluster |
string (uri) | |
datastore |
string (uri) | |
folder |
string (uri) | |
template_name |
string | |
cluster_name |
string | |
datastore_name |
string | |
folder_name |
string | |
ports |
array of objects | |
ports.url |
string (uri) | |
ports.uuid |
string (uuid) | |
ports.name |
string | |
ports.mac_address |
string | |
ports.network |
string (uri) | |
guest_power_state |
any | |
tools_state |
string | |
tools_installed |
boolean | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
VmwareVirtualMachineFieldEnum - API Source:
vmware_virtual_machine_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
guest_os |
any | |
guest_os_name |
string | |
cores |
integer | Number of cores in a VM |
cores_per_socket |
integer | Number of cores per socket in a VM |
ram |
integer | Memory size in MiB |
disk |
integer | Disk size in MiB |
disks |
array of objects | |
disks.url |
string (uri) | |
disks.uuid |
string (uuid) | |
disks.size |
integer | Size in MiB |
runtime_state |
string | |
cluster |
string (uri) | |
datastore |
string (uri) | |
folder |
string (uri) | |
template_name |
string | |
cluster_name |
string | |
datastore_name |
string | |
folder_name |
string | |
ports |
array of objects | |
ports.url |
string (uri) | |
ports.uuid |
string (uuid) | |
ports.name |
string | |
ports.mac_address |
string | |
ports.network |
string (uri) | |
guest_power_state |
any | |
tools_state |
string | |
tools_installed |
boolean | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Create
1 2 3 4 5 6 7 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
VmwareVirtualMachineRequest - API Source:
vmware_virtual_machine_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ✓ | |
description |
string | ||
service_settings |
string (uri) | ✓ | |
project |
string (uri) | ✓ | |
guest_os |
any | ||
cores |
integer | Number of cores in a VM | |
cores_per_socket |
integer | Number of cores per socket in a VM | |
ram |
integer | Memory size in MiB | |
template |
string (uri) | Constraints: write-only |
|
cluster |
string (uri) | ||
networks |
array of objects | Constraints: write-only |
|
networks.url |
string (uri) | ✓ | |
datastore |
string (uri) | ||
folder |
string (uri) |
201 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
guest_os |
any | |
guest_os_name |
string | |
cores |
integer | Number of cores in a VM |
cores_per_socket |
integer | Number of cores per socket in a VM |
ram |
integer | Memory size in MiB |
disk |
integer | Disk size in MiB |
disks |
array of objects | |
disks.url |
string (uri) | |
disks.uuid |
string (uuid) | |
disks.size |
integer | Size in MiB |
runtime_state |
string | |
cluster |
string (uri) | |
datastore |
string (uri) | |
folder |
string (uri) | |
template_name |
string | |
cluster_name |
string | |
datastore_name |
string | |
folder_name |
string | |
ports |
array of objects | |
ports.url |
string (uri) | |
ports.uuid |
string (uuid) | |
ports.name |
string | |
ports.mac_address |
string | |
ports.network |
string (uri) | |
guest_power_state |
any | |
tools_state |
string | |
tools_installed |
boolean | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Create disk
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
VmwareDiskRequest - API Source:
vmware_virtual_machine_create_disk
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
description |
string | ||
size |
integer | ✓ | Size in MiB |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
size |
integer | Size in MiB |
vm |
string (uri) | |
vm_uuid |
string (uuid) | |
vm_name |
string | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Create port
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
VmwarePortRequest - API Source:
vmware_virtual_machine_create_port
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
description |
string | |
network |
string (uri) | ✓ |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
description |
string |
service_name |
string |
service_settings |
string (uri) |
service_settings_uuid |
string (uuid) |
service_settings_state |
string |
service_settings_error_message |
string |
project |
string (uri) |
project_name |
string |
project_uuid |
string (uuid) |
customer |
string (uri) |
customer_uuid |
string (uuid) |
customer_name |
string |
customer_native_name |
string |
customer_abbreviation |
string |
error_message |
string |
error_traceback |
string |
resource_type |
string |
state |
any |
created |
string (date-time) |
modified |
string (date-time) |
backend_id |
string |
access_url |
string |
mac_address |
string |
vm |
string (uri) |
vm_uuid |
string (uuid) |
vm_name |
string |
network |
string (uri) |
network_name |
string |
marketplace_offering_uuid |
string |
marketplace_offering_name |
string |
marketplace_offering_plugin_options |
object (free-form) |
marketplace_category_uuid |
string |
marketplace_category_name |
string |
marketplace_resource_uuid |
string |
marketplace_plan_uuid |
string |
marketplace_resource_state |
string |
is_usage_based |
boolean |
is_limit_based |
boolean |
Synchronize resource state
Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
vmware_virtual_machine_pull
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
202 -
| Field | Type |
|---|---|
detail |
string |
409 -
| Field | Type |
|---|---|
detail |
string |
Unlink resource
Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
vmware_virtual_machine_unlink
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Update
1 2 3 4 5 6 7 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | |
- Model Source:
VmwareVirtualMachineRequest - API Source:
vmware_virtual_machine_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ✓ | |
description |
string | ||
service_settings |
string (uri) | ✓ | |
project |
string (uri) | ✓ | |
guest_os |
any | ||
cores |
integer | Number of cores in a VM | |
cores_per_socket |
integer | Number of cores per socket in a VM | |
ram |
integer | Memory size in MiB | |
template |
string (uri) | Constraints: write-only |
|
cluster |
string (uri) | ||
networks |
array of objects | Constraints: write-only |
|
networks.url |
string (uri) | ✓ | |
datastore |
string (uri) | ||
folder |
string (uri) |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
guest_os |
any | |
guest_os_name |
string | |
cores |
integer | Number of cores in a VM |
cores_per_socket |
integer | Number of cores per socket in a VM |
ram |
integer | Memory size in MiB |
disk |
integer | Disk size in MiB |
disks |
array of objects | |
disks.url |
string (uri) | |
disks.uuid |
string (uuid) | |
disks.size |
integer | Size in MiB |
runtime_state |
string | |
cluster |
string (uri) | |
datastore |
string (uri) | |
folder |
string (uri) | |
template_name |
string | |
cluster_name |
string | |
datastore_name |
string | |
folder_name |
string | |
ports |
array of objects | |
ports.url |
string (uri) | |
ports.uuid |
string (uuid) | |
ports.name |
string | |
ports.mac_address |
string | |
ports.network |
string (uri) | |
guest_power_state |
any | |
tools_state |
string | |
tools_installed |
boolean | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedVmwareVirtualMachineRequest - API Source:
vmware_virtual_machine_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
description |
string | ||
cores |
integer | Number of cores in a VM | |
cores_per_socket |
integer | Number of cores per socket in a VM | |
ram |
integer | Memory size in MiB |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
service_name |
string | |
service_settings |
string (uri) | |
service_settings_uuid |
string (uuid) | |
service_settings_state |
string | |
service_settings_error_message |
string | |
project |
string (uri) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
error_message |
string | |
error_traceback |
string | |
resource_type |
string | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
access_url |
string | |
guest_os |
any | |
guest_os_name |
string | |
cores |
integer | Number of cores in a VM |
cores_per_socket |
integer | Number of cores per socket in a VM |
ram |
integer | Memory size in MiB |
disk |
integer | Disk size in MiB |
disks |
array of objects | |
disks.url |
string (uri) | |
disks.uuid |
string (uuid) | |
disks.size |
integer | Size in MiB |
runtime_state |
string | |
cluster |
string (uri) | |
datastore |
string (uri) | |
folder |
string (uri) | |
template_name |
string | |
cluster_name |
string | |
datastore_name |
string | |
folder_name |
string | |
ports |
array of objects | |
ports.url |
string (uri) | |
ports.uuid |
string (uuid) | |
ports.name |
string | |
ports.mac_address |
string | |
ports.network |
string (uri) | |
guest_power_state |
any | |
tools_state |
string | |
tools_installed |
boolean | |
marketplace_offering_uuid |
string | |
marketplace_offering_name |
string | |
marketplace_offering_plugin_options |
object (free-form) | |
marketplace_category_uuid |
string | |
marketplace_category_name |
string | |
marketplace_resource_uuid |
string | |
marketplace_plan_uuid |
string | |
marketplace_resource_state |
string | |
is_usage_based |
boolean | |
is_limit_based |
boolean |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
vmware_virtual_machine_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
This endpoint provides access to Virtual Machine Remote Console aka VMRC
This endpoint provides access to Virtual Machine Remote Console aka VMRC.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
vmware_virtual_machine_console_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
This endpoint provides access to HTML Console aka WMKS
This endpoint provides access to HTML Console aka WMKS.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
vmware_virtual_machine_web_console_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
Reboot guest
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
vmware_virtual_machine_reboot_guest
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - No response body
Reset
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
vmware_virtual_machine_reset
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - No response body
Mark resource as ERRED
Manually transition the resource to ERRED state. This is useful for resources stuck in transitional states (CREATING, UPDATING, DELETING) that cannot be synced via pull. Staff-only operation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
SetErredRequest - API Source:
vmware_virtual_machine_set_erred
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
error_message |
string | |
error_traceback |
string |
200 -
| Field | Type |
|---|---|
detail |
string |
Mark resource as OK
Manually transition the resource to OK state and clear error fields. Staff-only operation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
vmware_virtual_machine_set_ok
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
detail |
string |
Shutdown guest
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
vmware_virtual_machine_shutdown_guest
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - No response body
Start
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
vmware_virtual_machine_start
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - No response body
Stop
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
vmware_virtual_machine_stop
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - No response body
Suspend
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
vmware_virtual_machine_suspend
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - No response body
Core
Identity management and access policy
Access Subnets
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/access-subnets/ |
List access subnets |
| GET | /api/access-subnets/{uuid}/ |
Retrieve access subnet |
| POST | /api/access-subnets/ |
Create an access subnet |
| PUT | /api/access-subnets/{uuid}/ |
Update an access subnet |
| PATCH | /api/access-subnets/{uuid}/ |
Partially update an access subnet |
| DELETE | /api/access-subnets/{uuid}/ |
Delete an access subnet |
List access subnets
Retrieve a list of access subnets. Staff and support users can see all subnets, while other users can only see subnets associated with customers they have a role in.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
access_subnets_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
customer |
string (uri) | Customer URL |
customer_uuid |
string (uuid) | Customer UUID |
description |
string | Description |
inet |
string | Inet |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
uuid |
string (uuid) |
inet |
string |
description |
string |
customer |
string (uri) |
Retrieve access subnet
Fetch the details of a specific access subnet by its UUID.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
access_subnets_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
inet |
string |
description |
string |
customer |
string (uri) |
Create an access subnet
Create a new access subnet for a customer.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
AccessSubnetRequest - API Source:
access_subnets_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Field | Type | Required |
|---|---|---|
inet |
string | ✓ |
description |
string | |
customer |
string (uri) | ✓ |
201 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
inet |
string |
description |
string |
customer |
string (uri) |
Update an access subnet
Update an existing access subnet.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
AccessSubnetRequest - API Source:
access_subnets_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
inet |
string | ✓ |
description |
string | |
customer |
string (uri) | ✓ |
200 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
inet |
string |
description |
string |
customer |
string (uri) |
Partially update an access subnet
Partially update an existing access subnet.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedAccessSubnetRequest - API Source:
access_subnets_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
inet |
string | |
description |
string |
200 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
inet |
string |
description |
string |
customer |
string (uri) |
Delete an access subnet
Delete an existing access subnet.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
access_subnets_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Auth Tokens
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/auth-tokens/ |
List Auth Tokens |
| GET | /api/auth-tokens/{user_id}/ |
Retrieve |
| DELETE | /api/auth-tokens/{user_id}/ |
Delete |
List Auth Tokens
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
auth_tokens_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
created |
string (date-time) | |
user |
string (uri) | |
user_first_name |
string | |
user_last_name |
string | |
user_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
user_is_active |
boolean | Designates whether this user should be treated as active. Unselect this instead of deleting accounts. |
user_token_lifetime |
integer | Token lifetime in seconds. |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
auth_tokens_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
user_id |
integer | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
created |
string (date-time) | |
user |
string (uri) | |
user_first_name |
string | |
user_last_name |
string | |
user_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
user_is_active |
boolean | Designates whether this user should be treated as active. Unselect this instead of deleting accounts. |
user_token_lifetime |
integer | Token lifetime in seconds. |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
auth_tokens_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
user_id |
integer | ✓ |
204 - No response body
Auth Valimo
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| POST | /api/auth-valimo/ |
Create |
| Other Actions | ||
| POST | /api/auth-valimo/result/ |
Result |
Core CRUD
Create
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
- Model Source:
AuthResultRequest - API Source:
auth_valimo_create
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Field | Type | Required |
|---|---|---|
phone |
string | ✓ |
201 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
token |
string | |
phone |
string | |
message |
string | This message will be shown to user. |
state |
any | |
error_message |
string | |
details |
string | Cancellation details. |
Other Actions
Result
1 2 3 4 5 6 7 8 9 | |
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
- Model Source:
AuthResultUUIDRequest - API Source:
auth_valimo_result
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Field | Type | Required | Description |
|---|---|---|---|
uuid |
string (uuid) | ✓ | UUID of the authentication result. |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
token |
string | |
phone |
string | |
message |
string | This message will be shown to user. |
state |
any | |
error_message |
string | |
details |
string | Cancellation details. |
Freeipa Profiles
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/freeipa-profiles/ |
List Freeipa Profiles |
| GET | /api/freeipa-profiles/{uuid}/ |
Retrieve |
| POST | /api/freeipa-profiles/ |
Create |
| POST | /api/freeipa-profiles/{uuid}/update_ssh_keys/ |
Update SSH keys for profile |
| PUT | /api/freeipa-profiles/{uuid}/ |
Update |
| PATCH | /api/freeipa-profiles/{uuid}/ |
Partial Update |
List Freeipa Profiles
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
freeipa_profiles_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
query |
string | Filter by username, user UUID, first name or last name |
user |
string (uuid) |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
username |
string | Letters, numbers and ./+/-/_ characters |
agreement_date |
string (date-time) | Indicates when the user has agreed with the policy. |
is_active |
boolean | |
user |
string (uri) | |
user_uuid |
string (uuid) | |
user_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
user_full_name |
string |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
freeipa_profiles_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
username |
string | Letters, numbers and ./+/-/_ characters |
agreement_date |
string (date-time) | Indicates when the user has agreed with the policy. |
is_active |
boolean | |
user |
string (uri) | |
user_uuid |
string (uuid) | |
user_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
user_full_name |
string |
Create
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
- Model Source:
FreeipaProfileRequest - API Source:
freeipa_profiles_create
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Field | Type | Required | Description |
|---|---|---|---|
username |
string | ✓ | Letters, numbers and ./+/-/_ characters |
agreement_date |
string (date-time) | Indicates when the user has agreed with the policy. |
201 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
username |
string | Letters, numbers and ./+/-/_ characters |
agreement_date |
string (date-time) | Indicates when the user has agreed with the policy. |
is_active |
boolean | |
user |
string (uri) | |
user_uuid |
string (uuid) | |
user_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
user_full_name |
string |
Update SSH keys for profile
Update SSH keys for profile.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
freeipa_profiles_update_ssh_keys
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - No response body
Update
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
FreeipaProfileRequest - API Source:
freeipa_profiles_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
username |
string | ✓ | Letters, numbers and ./+/-/_ characters |
agreement_date |
string (date-time) | Indicates when the user has agreed with the policy. |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
username |
string | Letters, numbers and ./+/-/_ characters |
agreement_date |
string (date-time) | Indicates when the user has agreed with the policy. |
is_active |
boolean | |
user |
string (uri) | |
user_uuid |
string (uuid) | |
user_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
user_full_name |
string |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
freeipa_profiles_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
username |
string | Letters, numbers and ./+/-/_ characters |
agreement_date |
string (date-time) | Indicates when the user has agreed with the policy. |
is_active |
boolean | |
user |
string (uri) | |
user_uuid |
string (uuid) | |
user_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
user_full_name |
string |
Google Auth
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/google-auth/ |
List Google Auth |
| GET | /api/google-auth/{uuid}/ |
Retrieve |
| Other Actions | ||
| GET | /api/google-auth/{uuid}/authorize/ |
Authorize |
| GET | /api/google-auth/callback/ |
Callback endpoint for Google authorization |
Core CRUD
List Google Auth
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 | |
- Model Source:
GoogleCredentialsFieldEnum - API Source:
google_auth_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
field |
array | |
has_credentials |
boolean | has_credentials |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
description |
string | |
enable_notifications |
boolean | |
customer |
string (uri) | |
customer_name |
string | |
customer_uuid |
string (uuid) | |
customer_image |
string (uri) | |
customer_abbreviation |
string | |
customer_slug |
string | |
customer_native_name |
string | |
customer_country |
string | |
image |
string (uri) | |
organization_groups |
array of objects | |
organization_groups.uuid |
string (uuid) | |
organization_groups.url |
string (uri) | |
organization_groups.name |
string | |
organization_groups.parent_uuid |
string (uuid) | UUID of the parent organization group |
organization_groups.parent_name |
string | Name of the parent organization group |
organization_groups.parent |
string (uri) | |
organization_groups.customers_count |
integer | Number of customers in this organization group |
offering_count |
integer | |
calendar_token |
string | |
calendar_refresh_token |
string | |
google_auth_url |
string |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
GoogleCredentialsFieldEnum - API Source:
google_auth_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
description |
string | |
enable_notifications |
boolean | |
customer |
string (uri) | |
customer_name |
string | |
customer_uuid |
string (uuid) | |
customer_image |
string (uri) | |
customer_abbreviation |
string | |
customer_slug |
string | |
customer_native_name |
string | |
customer_country |
string | |
image |
string (uri) | |
organization_groups |
array of objects | |
organization_groups.uuid |
string (uuid) | |
organization_groups.url |
string (uri) | |
organization_groups.name |
string | |
organization_groups.parent_uuid |
string (uuid) | UUID of the parent organization group |
organization_groups.parent_name |
string | Name of the parent organization group |
organization_groups.parent |
string (uri) | |
organization_groups.customers_count |
integer | Number of customers in this organization group |
offering_count |
integer | |
calendar_token |
string | |
calendar_refresh_token |
string | |
google_auth_url |
string |
Other Actions
Authorize
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
GoogleCredentialsFieldEnum - API Source:
google_auth_authorize_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
description |
string | |
enable_notifications |
boolean | |
customer |
string (uri) | |
customer_name |
string | |
customer_uuid |
string (uuid) | |
customer_image |
string (uri) | |
customer_abbreviation |
string | |
customer_slug |
string | |
customer_native_name |
string | |
customer_country |
string | |
image |
string (uri) | |
organization_groups |
array of objects | |
organization_groups.uuid |
string (uuid) | |
organization_groups.url |
string (uri) | |
organization_groups.name |
string | |
organization_groups.parent_uuid |
string (uuid) | UUID of the parent organization group |
organization_groups.parent_name |
string | Name of the parent organization group |
organization_groups.parent |
string (uri) | |
organization_groups.customers_count |
integer | Number of customers in this organization group |
offering_count |
integer | |
calendar_token |
string | |
calendar_refresh_token |
string | |
google_auth_url |
string |
Callback endpoint for Google authorization
Callback endpoint for Google authorization.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- API Source:
google_auth_callback_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Name | Type | Required | Description |
|---|---|---|---|
code |
string | ✓ | Authorization code |
state |
string | ✓ | Service provider UUID |
200 - No response body
Identity Providers
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/identity-providers/ |
List Identity Providers |
| GET | /api/identity-providers/{provider}/ |
Retrieve |
| POST | /api/identity-providers/ |
Create |
| PUT | /api/identity-providers/{provider}/ |
Update |
| PATCH | /api/identity-providers/{provider}/ |
Partial Update |
| DELETE | /api/identity-providers/{provider}/ |
Delete |
| Other Actions | ||
| POST | /api/identity-providers/discover_metadata/ |
Discover OIDC provider metadata |
| POST | /api/identity-providers/generate-mapping/ |
Generate default attribute mapping |
Core CRUD
List Identity Providers
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
identity_providers_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
provider |
string | |
is_active |
boolean | |
client_id |
string | ID of application used for OAuth authentication. |
client_secret |
string | Application secret key. |
verify_ssl |
boolean | |
enable_post_logout_redirect |
boolean | |
enable_pkce |
boolean | |
discovery_url |
string | The endpoint for endpoint discovery. |
userinfo_url |
string | The endpoint for fetching user info. |
token_url |
string | The endpoint for obtaining auth token. |
auth_url |
string | The endpoint for authorization request flow. |
logout_url |
string | The endpoint used to redirect after sign-out. |
label |
string | Human-readable identity provider is label. |
management_url |
string | The endpoint for user details management. |
protected_fields |
any | |
extra_scope |
string | Space-separated list of scopes to request during authentication. |
user_field |
string | The field in Waldur User model to be used for looking up the user |
user_claim |
string | The OIDC claim from the userinfo endpoint to be used as the value for the lookup field. |
attribute_mapping |
any | A JSON object mapping Waldur User model fields to OIDC claims. Example: |
extra_fields |
string | Space-separated list of extra fields to persist. |
allowed_redirects |
any | List of allowed redirect URLs for OAuth authentication. URLs must be exact matches (origin only: scheme + domain + port). HTTPS required except for localhost. No wildcards, paths, query params, or fragments. Example: ["https://portal1.example.com", "https://portal2.example.com:8443"]. If empty, falls back to HOMEPORT_URL setting. |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
identity_providers_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
provider |
string | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
provider |
string | |
is_active |
boolean | |
client_id |
string | ID of application used for OAuth authentication. |
client_secret |
string | Application secret key. |
verify_ssl |
boolean | |
enable_post_logout_redirect |
boolean | |
enable_pkce |
boolean | |
discovery_url |
string | The endpoint for endpoint discovery. |
userinfo_url |
string | The endpoint for fetching user info. |
token_url |
string | The endpoint for obtaining auth token. |
auth_url |
string | The endpoint for authorization request flow. |
logout_url |
string | The endpoint used to redirect after sign-out. |
label |
string | Human-readable identity provider is label. |
management_url |
string | The endpoint for user details management. |
protected_fields |
any | |
extra_scope |
string | Space-separated list of scopes to request during authentication. |
user_field |
string | The field in Waldur User model to be used for looking up the user |
user_claim |
string | The OIDC claim from the userinfo endpoint to be used as the value for the lookup field. |
attribute_mapping |
any | A JSON object mapping Waldur User model fields to OIDC claims. Example: |
extra_fields |
string | Space-separated list of extra fields to persist. |
allowed_redirects |
any | List of allowed redirect URLs for OAuth authentication. URLs must be exact matches (origin only: scheme + domain + port). HTTPS required except for localhost. No wildcards, paths, query params, or fragments. Example: ["https://portal1.example.com", "https://portal2.example.com:8443"]. If empty, falls back to HOMEPORT_URL setting. |
Create
1 2 3 4 5 6 7 8 9 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 | |
- Model Source:
IdentityProviderRequest - API Source:
identity_providers_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Field | Type | Required | Description |
|---|---|---|---|
provider |
string | ✓ | |
is_active |
boolean | ||
client_id |
string | ✓ | ID of application used for OAuth authentication. |
client_secret |
string | ✓ | Application secret key. |
verify_ssl |
boolean | ||
enable_post_logout_redirect |
boolean | ||
enable_pkce |
boolean | ||
discovery_url |
string | ✓ | The endpoint for endpoint discovery. |
label |
string | ✓ | Human-readable identity provider is label. |
management_url |
string | The endpoint for user details management. | |
protected_fields |
any | ||
extra_scope |
string | Space-separated list of scopes to request during authentication. | |
user_field |
string | The field in Waldur User model to be used for looking up the user | |
user_claim |
string | The OIDC claim from the userinfo endpoint to be used as the value for the lookup field. | |
attribute_mapping |
any | A JSON object mapping Waldur User model fields to OIDC claims. Example: | |
extra_fields |
string | Space-separated list of extra fields to persist. | |
allowed_redirects |
any | List of allowed redirect URLs for OAuth authentication. URLs must be exact matches (origin only: scheme + domain + port). HTTPS required except for localhost. No wildcards, paths, query params, or fragments. Example: ["https://portal1.example.com", "https://portal2.example.com:8443"]. If empty, falls back to HOMEPORT_URL setting. |
201 -
| Field | Type | Description |
|---|---|---|
provider |
string | |
is_active |
boolean | |
client_id |
string | ID of application used for OAuth authentication. |
client_secret |
string | Application secret key. |
verify_ssl |
boolean | |
enable_post_logout_redirect |
boolean | |
enable_pkce |
boolean | |
discovery_url |
string | The endpoint for endpoint discovery. |
userinfo_url |
string | The endpoint for fetching user info. |
token_url |
string | The endpoint for obtaining auth token. |
auth_url |
string | The endpoint for authorization request flow. |
logout_url |
string | The endpoint used to redirect after sign-out. |
label |
string | Human-readable identity provider is label. |
management_url |
string | The endpoint for user details management. |
protected_fields |
any | |
extra_scope |
string | Space-separated list of scopes to request during authentication. |
user_field |
string | The field in Waldur User model to be used for looking up the user |
user_claim |
string | The OIDC claim from the userinfo endpoint to be used as the value for the lookup field. |
attribute_mapping |
any | A JSON object mapping Waldur User model fields to OIDC claims. Example: |
extra_fields |
string | Space-separated list of extra fields to persist. |
allowed_redirects |
any | List of allowed redirect URLs for OAuth authentication. URLs must be exact matches (origin only: scheme + domain + port). HTTPS required except for localhost. No wildcards, paths, query params, or fragments. Example: ["https://portal1.example.com", "https://portal2.example.com:8443"]. If empty, falls back to HOMEPORT_URL setting. |
Update
1 2 3 4 5 6 7 8 9 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 | |
- Model Source:
IdentityProviderRequest - API Source:
identity_providers_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | |
| Name | Type | Required |
|---|---|---|
provider |
string | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
provider |
string | ✓ | |
is_active |
boolean | ||
client_id |
string | ✓ | ID of application used for OAuth authentication. |
client_secret |
string | ✓ | Application secret key. |
verify_ssl |
boolean | ||
enable_post_logout_redirect |
boolean | ||
enable_pkce |
boolean | ||
discovery_url |
string | ✓ | The endpoint for endpoint discovery. |
label |
string | ✓ | Human-readable identity provider is label. |
management_url |
string | The endpoint for user details management. | |
protected_fields |
any | ||
extra_scope |
string | Space-separated list of scopes to request during authentication. | |
user_field |
string | The field in Waldur User model to be used for looking up the user | |
user_claim |
string | The OIDC claim from the userinfo endpoint to be used as the value for the lookup field. | |
attribute_mapping |
any | A JSON object mapping Waldur User model fields to OIDC claims. Example: | |
extra_fields |
string | Space-separated list of extra fields to persist. | |
allowed_redirects |
any | List of allowed redirect URLs for OAuth authentication. URLs must be exact matches (origin only: scheme + domain + port). HTTPS required except for localhost. No wildcards, paths, query params, or fragments. Example: ["https://portal1.example.com", "https://portal2.example.com:8443"]. If empty, falls back to HOMEPORT_URL setting. |
200 -
| Field | Type | Description |
|---|---|---|
provider |
string | |
is_active |
boolean | |
client_id |
string | ID of application used for OAuth authentication. |
client_secret |
string | Application secret key. |
verify_ssl |
boolean | |
enable_post_logout_redirect |
boolean | |
enable_pkce |
boolean | |
discovery_url |
string | The endpoint for endpoint discovery. |
userinfo_url |
string | The endpoint for fetching user info. |
token_url |
string | The endpoint for obtaining auth token. |
auth_url |
string | The endpoint for authorization request flow. |
logout_url |
string | The endpoint used to redirect after sign-out. |
label |
string | Human-readable identity provider is label. |
management_url |
string | The endpoint for user details management. |
protected_fields |
any | |
extra_scope |
string | Space-separated list of scopes to request during authentication. |
user_field |
string | The field in Waldur User model to be used for looking up the user |
user_claim |
string | The OIDC claim from the userinfo endpoint to be used as the value for the lookup field. |
attribute_mapping |
any | A JSON object mapping Waldur User model fields to OIDC claims. Example: |
extra_fields |
string | Space-separated list of extra fields to persist. |
allowed_redirects |
any | List of allowed redirect URLs for OAuth authentication. URLs must be exact matches (origin only: scheme + domain + port). HTTPS required except for localhost. No wildcards, paths, query params, or fragments. Example: ["https://portal1.example.com", "https://portal2.example.com:8443"]. If empty, falls back to HOMEPORT_URL setting. |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedIdentityProviderRequest - API Source:
identity_providers_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
provider |
string | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
provider |
string | ||
is_active |
boolean | ||
client_id |
string | ID of application used for OAuth authentication. | |
client_secret |
string | Application secret key. | |
verify_ssl |
boolean | ||
enable_post_logout_redirect |
boolean | ||
enable_pkce |
boolean | ||
discovery_url |
string | The endpoint for endpoint discovery. | |
label |
string | Human-readable identity provider is label. | |
management_url |
string | The endpoint for user details management. | |
protected_fields |
any | ||
extra_scope |
string | Space-separated list of scopes to request during authentication. | |
user_field |
string | The field in Waldur User model to be used for looking up the user | |
user_claim |
string | The OIDC claim from the userinfo endpoint to be used as the value for the lookup field. | |
attribute_mapping |
any | A JSON object mapping Waldur User model fields to OIDC claims. Example: | |
extra_fields |
string | Space-separated list of extra fields to persist. | |
allowed_redirects |
any | List of allowed redirect URLs for OAuth authentication. URLs must be exact matches (origin only: scheme + domain + port). HTTPS required except for localhost. No wildcards, paths, query params, or fragments. Example: ["https://portal1.example.com", "https://portal2.example.com:8443"]. If empty, falls back to HOMEPORT_URL setting. |
200 -
| Field | Type | Description |
|---|---|---|
provider |
string | |
is_active |
boolean | |
client_id |
string | ID of application used for OAuth authentication. |
client_secret |
string | Application secret key. |
verify_ssl |
boolean | |
enable_post_logout_redirect |
boolean | |
enable_pkce |
boolean | |
discovery_url |
string | The endpoint for endpoint discovery. |
userinfo_url |
string | The endpoint for fetching user info. |
token_url |
string | The endpoint for obtaining auth token. |
auth_url |
string | The endpoint for authorization request flow. |
logout_url |
string | The endpoint used to redirect after sign-out. |
label |
string | Human-readable identity provider is label. |
management_url |
string | The endpoint for user details management. |
protected_fields |
any | |
extra_scope |
string | Space-separated list of scopes to request during authentication. |
user_field |
string | The field in Waldur User model to be used for looking up the user |
user_claim |
string | The OIDC claim from the userinfo endpoint to be used as the value for the lookup field. |
attribute_mapping |
any | A JSON object mapping Waldur User model fields to OIDC claims. Example: |
extra_fields |
string | Space-separated list of extra fields to persist. |
allowed_redirects |
any | List of allowed redirect URLs for OAuth authentication. URLs must be exact matches (origin only: scheme + domain + port). HTTPS required except for localhost. No wildcards, paths, query params, or fragments. Example: ["https://portal1.example.com", "https://portal2.example.com:8443"]. If empty, falls back to HOMEPORT_URL setting. |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
identity_providers_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
provider |
string | ✓ |
204 - No response body
Other Actions
Discover OIDC provider metadata
Fetches OIDC discovery metadata from the provider and returns supported claims, scopes, and suggested mappings to Waldur User fields. Use this to configure attribute_mapping when setting up a new identity provider.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
- Model Source:
DiscoverMetadataRequestRequest - API Source:
identity_providers_discover_metadata
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Field | Type | Required | Description |
|---|---|---|---|
discovery_url |
string (uri) | ✓ | OIDC discovery URL (e.g., https://idp.example.com/.well-known/openid-configuration) |
verify_ssl |
boolean | Whether to verify SSL certificate Constraints: default: True |
200 -
| Field | Type | Description |
|---|---|---|
claims_supported |
array of strings | List of claims supported by the OIDC provider |
scopes_supported |
array of strings | List of scopes supported by the OIDC provider |
endpoints |
object (free-form) | OIDC endpoints (authorization, token, userinfo, logout) |
waldur_fields |
array of objects | Waldur User fields with suggested OIDC claim mappings |
waldur_fields.field |
string | Waldur User model field name |
waldur_fields.description |
string | Human-readable field description |
waldur_fields.suggested_claims |
array of strings | OIDC claims that could map to this field, ordered by likelihood |
waldur_fields.available_claims |
array of strings | Claims from this IdP that match the suggestions |
suggested_scopes |
array of strings | Recommended scopes to request based on claim mappings |
Generate default attribute mapping
Generates a suggested attribute_mapping configuration based on the claims supported by an OIDC provider. This can be used as a starting point when creating a new identity provider.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
- Model Source:
DiscoverMetadataRequestRequest - API Source:
identity_providers_generate_mapping
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Field | Type | Required | Description |
|---|---|---|---|
discovery_url |
string (uri) | ✓ | OIDC discovery URL (e.g., https://idp.example.com/.well-known/openid-configuration) |
verify_ssl |
boolean | Whether to verify SSL certificate Constraints: default: True |
200 -
| Field | Type | Description |
|---|---|---|
attribute_mapping |
object (free-form) | Suggested mapping of Waldur fields to OIDC claims |
extra_scope |
string | Suggested scopes to request (space-separated) |
Keys
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/keys/ |
List Keys |
| GET | /api/keys/{uuid}/ |
Retrieve |
| POST | /api/keys/ |
Create |
| DELETE | /api/keys/{uuid}/ |
Delete |
| Other Actions | ||
| GET | /api/keys/{uuid}/history/at/ |
Get object state at a specific timestamp |
| GET | /api/keys/{uuid}/history/ |
Get version history |
Core CRUD
List Keys
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- Model Source:
SshKeyFieldEnum - Model Source:
SshKeyOEnum - API Source:
keys_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
created |
string (date-time) | Created after |
field |
array | |
fingerprint_md5 |
string | |
fingerprint_sha256 |
string | |
fingerprint_sha512 |
string | |
is_shared |
boolean | |
modified |
string (date-time) | Modified after |
name |
string | Name |
name_exact |
string | Name (exact) |
o |
array | Ordering |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
user_uuid |
string (uuid) | User UUID |
uuid |
string (uuid) | UUID |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
public_key |
string |
fingerprint_md5 |
string |
fingerprint_sha256 |
string |
fingerprint_sha512 |
string |
user_uuid |
string (uuid) |
is_shared |
boolean |
type |
string |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
SshKeyFieldEnum - API Source:
keys_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
public_key |
string |
fingerprint_md5 |
string |
fingerprint_sha256 |
string |
fingerprint_sha512 |
string |
user_uuid |
string (uuid) |
is_shared |
boolean |
type |
string |
Create
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
- Model Source:
SshKeyRequest - API Source:
keys_create
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Field | Type | Required |
|---|---|---|
name |
string | |
public_key |
string | ✓ |
201 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
public_key |
string |
fingerprint_md5 |
string |
fingerprint_sha256 |
string |
fingerprint_sha512 |
string |
user_uuid |
string (uuid) |
is_shared |
boolean |
type |
string |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
keys_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
Get object state at a specific timestamp
Returns the state of the object as it was at the specified timestamp. Only accessible by staff and support users.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- API Source:
keys_history_at_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Required | Description |
|---|---|---|---|
timestamp |
string | ✓ | ISO 8601 timestamp to query the object state at |
200 -
| Field | Type | Description |
|---|---|---|
id |
integer | Version ID |
revision_date |
string (date-time) | When this revision was created |
revision_user |
object (free-form) | User who created this revision |
revision_comment |
string | Comment describing the revision |
serialized_data |
object (free-form) | Serialized model fields at this revision |
400 -
404 -
Get version history
Returns the version history for this object. Only accessible by staff and support users.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
- Model Source:
SshKeyOEnum - API Source:
keys_history_list
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
created |
string (date-time) | Created after |
created_after |
string | Filter versions created after this timestamp (ISO 8601) |
created_before |
string | Filter versions created before this timestamp (ISO 8601) |
fingerprint_md5 |
string | |
fingerprint_sha256 |
string | |
fingerprint_sha512 |
string | |
is_shared |
boolean | |
modified |
string (date-time) | Modified after |
name |
string | Name |
name_exact |
string | Name (exact) |
o |
array | Ordering |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
user_uuid |
string (uuid) | User UUID |
uuid |
string (uuid) | UUID |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
id |
integer | Version ID |
revision_date |
string (date-time) | When this revision was created |
revision_user |
object (free-form) | User who created this revision |
revision_comment |
string | Comment describing the revision |
serialized_data |
object (free-form) | Serialized model fields at this revision |
Lexis Links
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/lexis-links/ |
List Lexis Links |
| GET | /api/lexis-links/{uuid}/ |
Retrieve |
| POST | /api/lexis-links/ |
Create |
| PUT | /api/lexis-links/{uuid}/ |
Update |
| PATCH | /api/lexis-links/{uuid}/ |
Partial Update |
| DELETE | /api/lexis-links/{uuid}/ |
Delete |
List Lexis Links
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
lexis_links_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
customer_uuid |
string (uuid) | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
project_uuid |
string (uuid) | |
query |
string | Filter by robot account username or type |
resource_uuid |
string (uuid) | |
uuid |
string (uuid) |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
created |
string (date-time) |
modified |
string (date-time) |
robot_account |
string (uri) |
robot_account_username |
string |
robot_account_type |
string |
state |
string |
resource_uuid |
string (uuid) |
resource_name |
string |
resource_type |
string |
resource_backend_id |
string |
resource_end_date |
string (date-time) |
project_uuid |
string (uuid) |
project_name |
string |
customer_uuid |
string (uuid) |
customer_name |
string |
heappe_project_id |
integer |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
lexis_links_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
created |
string (date-time) |
modified |
string (date-time) |
robot_account |
string (uri) |
robot_account_username |
string |
robot_account_type |
string |
state |
string |
resource_uuid |
string (uuid) |
resource_name |
string |
resource_type |
string |
resource_backend_id |
string |
resource_end_date |
string (date-time) |
project_uuid |
string (uuid) |
project_name |
string |
customer_uuid |
string (uuid) |
customer_name |
string |
heappe_project_id |
integer |
Create
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
- Model Source:
LexisLinkCreateRequest - API Source:
lexis_links_create
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Field | Type | Required |
|---|---|---|
resource |
string (uri) | ✓ |
201 - No response body
Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
LexisLinkRequest - API Source:
lexis_links_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
heappe_project_id |
integer |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
created |
string (date-time) |
modified |
string (date-time) |
robot_account |
string (uri) |
robot_account_username |
string |
robot_account_type |
string |
state |
string |
resource_uuid |
string (uuid) |
resource_name |
string |
resource_type |
string |
resource_backend_id |
string |
resource_end_date |
string (date-time) |
project_uuid |
string (uuid) |
project_name |
string |
customer_uuid |
string (uuid) |
customer_name |
string |
heappe_project_id |
integer |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedLexisLinkRequest - API Source:
lexis_links_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
heappe_project_id |
integer |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
created |
string (date-time) |
modified |
string (date-time) |
robot_account |
string (uri) |
robot_account_username |
string |
robot_account_type |
string |
state |
string |
resource_uuid |
string (uuid) |
resource_name |
string |
resource_type |
string |
resource_backend_id |
string |
resource_end_date |
string (date-time) |
project_uuid |
string (uuid) |
project_name |
string |
customer_uuid |
string (uuid) |
customer_name |
string |
heappe_project_id |
integer |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
lexis_links_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Remote Eduteams
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| POST | /api/remote-eduteams/ |
Allows to pull user details from remote eduTEAMS instance |
Allows to pull user details from remote eduTEAMS instance
Allows to pull user details from remote eduTEAMS instance.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
- Model Source:
RemoteEduteamsRequestRequest - API Source:
remote_eduteams
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Field | Type | Required |
|---|---|---|
cuid |
string | ✓ |
200 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
Invitations and permissions
Customer Permissions Reviews
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/customer-permissions-reviews/ |
List Customer Permissions Reviews |
| GET | /api/customer-permissions-reviews/{uuid}/ |
Retrieve |
| Other Actions | ||
| POST | /api/customer-permissions-reviews/{uuid}/close/ |
Close customer permission review |
Core CRUD
List Customer Permissions Reviews
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 | |
- Model Source:
CustomerPermissionReviewOEnum - API Source:
customer_permissions_reviews_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
closed |
string (date-time) | |
customer_uuid |
string (uuid) | Customer UUID |
is_pending |
boolean | Is pending |
o |
array | Ordering |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
reviewer_uuid |
string (uuid) | Reviewer UUID |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
reviewer_full_name |
string |
reviewer_uuid |
string (uuid) |
is_pending |
boolean |
created |
string (date-time) |
closed |
string (date-time) |
customer_uuid |
string (uuid) |
customer_name |
string |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
customer_permissions_reviews_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
reviewer_full_name |
string |
reviewer_uuid |
string (uuid) |
is_pending |
boolean |
created |
string (date-time) |
closed |
string (date-time) |
customer_uuid |
string (uuid) |
customer_name |
string |
Other Actions
Close customer permission review
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
customer_permissions_reviews_close
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - No response body
Project Permissions Reviews
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/project-permissions-reviews/ |
List Project Permissions Reviews |
| GET | /api/project-permissions-reviews/{uuid}/ |
Retrieve |
| Other Actions | ||
| POST | /api/project-permissions-reviews/{uuid}/close/ |
Close project permission review |
Core CRUD
List Project Permissions Reviews
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 | |
- Model Source:
CustomerPermissionReviewOEnum - API Source:
project_permissions_reviews_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
closed |
string (date-time) | |
is_pending |
boolean | Is pending |
o |
array | Ordering |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
project_uuid |
string (uuid) | Project UUID |
reviewer_uuid |
string (uuid) | Reviewer UUID |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
reviewer_full_name |
string |
reviewer_uuid |
string (uuid) |
is_pending |
boolean |
created |
string (date-time) |
closed |
string (date-time) |
project_uuid |
string (uuid) |
project_name |
string |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
project_permissions_reviews_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
reviewer_full_name |
string |
reviewer_uuid |
string (uuid) |
is_pending |
boolean |
created |
string (date-time) |
closed |
string (date-time) |
project_uuid |
string (uuid) |
project_name |
string |
Other Actions
Close project permission review
Complete project permission review.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
project_permissions_reviews_close
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - No response body
User Group Invitations
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/user-group-invitations/ |
List group invitations |
| GET | /api/user-group-invitations/{uuid}/ |
Retrieve group invitation |
| POST | /api/user-group-invitations/ |
Create group invitation |
| PUT | /api/user-group-invitations/{uuid}/ |
Update a group invitation |
| PATCH | /api/user-group-invitations/{uuid}/ |
Partially update a group invitation |
| DELETE | /api/user-group-invitations/{uuid}/ |
Delete a group invitation |
| Other Actions | ||
| GET | /api/user-group-invitations/{uuid}/projects/ |
List projects for a customer-scoped group invitation |
| POST | /api/user-group-invitations/{uuid}/cancel/ |
Cancel a group invitation |
| POST | /api/user-group-invitations/{uuid}/submit_request/ |
Submit a permission request |
Core CRUD
List group invitations
Retrieve a list of group invitations. Unauthenticated users can only see public invitations.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 | |
- Model Source:
BackendResourceReqOEnum - API Source:
user_group_invitations_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
customer_uuid |
string (uuid) | |
is_active |
boolean | |
is_public |
boolean | |
o |
array | Ordering |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
role_name |
string | |
role_uuid |
string (uuid) | |
scope |
string (uri) | Filter by scope URL. |
scope_type |
string |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
scope_uuid |
string (uuid) | UUID of the invitation scope (Customer or Project) |
scope_name |
string | Name of the invitation scope |
scope_description |
string | Description of the invitation scope |
scope_type |
string | Type of the invitation scope (e.g., 'customer', 'project') |
customer_uuid |
string (uuid) | UUID of the customer organization |
customer_name |
string | Name of the customer organization |
role_name |
string | Name of the role being granted (e.g., 'PROJECT.ADMIN') |
role_description |
string | Description of the role being granted |
created_by_full_name |
string | Full name of the user who created this invitation |
created_by_username |
string | Username of the user who created this invitation |
created_by_image |
string (uri) | Profile image of the user who created this invitation |
url |
string (uri) | |
uuid |
string (uuid) | |
role |
string (uuid) | UUID of the role to grant to the invited user |
created |
string (date-time) | |
is_active |
boolean | |
is_public |
boolean | Allow non-authenticated users to see and accept this invitation. Only staff can create public invitations. |
auto_create_project |
boolean | Create project and grant project permissions instead of customer permissions |
auto_approve |
boolean | Automatically approve permission requests from users matching email patterns or affiliations |
project_name_template |
string | Template for project name. Supports {username}, {email}, {full_name} variables |
project_role |
string (uuid) | UUID of the project role to grant if auto_create_project is enabled |
user_affiliations |
any | |
user_email_patterns |
any | |
user_identity_sources |
any | List of allowed identity sources (identity providers). |
scope_image |
string (uri) | Image URL of the invitation scope (Customer or Project) |
custom_text |
string | Custom description text displayed to users viewing this invitation. |
Retrieve group invitation
Retrieve details of a specific group invitation. Unauthenticated users can only see public invitations.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
user_group_invitations_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
scope_uuid |
string (uuid) | UUID of the invitation scope (Customer or Project) |
scope_name |
string | Name of the invitation scope |
scope_description |
string | Description of the invitation scope |
scope_type |
string | Type of the invitation scope (e.g., 'customer', 'project') |
customer_uuid |
string (uuid) | UUID of the customer organization |
customer_name |
string | Name of the customer organization |
role_name |
string | Name of the role being granted (e.g., 'PROJECT.ADMIN') |
role_description |
string | Description of the role being granted |
created_by_full_name |
string | Full name of the user who created this invitation |
created_by_username |
string | Username of the user who created this invitation |
created_by_image |
string (uri) | Profile image of the user who created this invitation |
url |
string (uri) | |
uuid |
string (uuid) | |
role |
string (uuid) | UUID of the role to grant to the invited user |
created |
string (date-time) | |
is_active |
boolean | |
is_public |
boolean | Allow non-authenticated users to see and accept this invitation. Only staff can create public invitations. |
auto_create_project |
boolean | Create project and grant project permissions instead of customer permissions |
auto_approve |
boolean | Automatically approve permission requests from users matching email patterns or affiliations |
project_name_template |
string | Template for project name. Supports {username}, {email}, {full_name} variables |
project_role |
string (uuid) | UUID of the project role to grant if auto_create_project is enabled |
user_affiliations |
any | |
user_email_patterns |
any | |
user_identity_sources |
any | List of allowed identity sources (identity providers). |
scope_image |
string (uri) | Image URL of the invitation scope (Customer or Project) |
custom_text |
string | Custom description text displayed to users viewing this invitation. |
Create group invitation
Create a new group invitation, which acts as a template for users to request permissions.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
GroupInvitationRequest - API Source:
user_group_invitations_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Field | Type | Required | Description |
|---|---|---|---|
role |
string (uuid) | ✓ | UUID of the role to grant to the invited user |
scope |
string | ✓ | URL of the scope (Customer or Project) for this invitation Constraints: write-only |
is_public |
boolean | Allow non-authenticated users to see and accept this invitation. Only staff can create public invitations. | |
auto_create_project |
boolean | Create project and grant project permissions instead of customer permissions | |
auto_approve |
boolean | Automatically approve permission requests from users matching email patterns or affiliations | |
project_name_template |
string | Template for project name. Supports {username}, {email}, {full_name} variables | |
project_role |
string (uuid) | UUID of the project role to grant if auto_create_project is enabled | |
user_affiliations |
any | ||
user_email_patterns |
any | ||
user_identity_sources |
any | List of allowed identity sources (identity providers). | |
custom_text |
string | Custom description text displayed to users viewing this invitation. |
201 -
| Field | Type | Description |
|---|---|---|
scope_uuid |
string (uuid) | UUID of the invitation scope (Customer or Project) |
scope_name |
string | Name of the invitation scope |
scope_description |
string | Description of the invitation scope |
scope_type |
string | Type of the invitation scope (e.g., 'customer', 'project') |
customer_uuid |
string (uuid) | UUID of the customer organization |
customer_name |
string | Name of the customer organization |
role_name |
string | Name of the role being granted (e.g., 'PROJECT.ADMIN') |
role_description |
string | Description of the role being granted |
created_by_full_name |
string | Full name of the user who created this invitation |
created_by_username |
string | Username of the user who created this invitation |
created_by_image |
string (uri) | Profile image of the user who created this invitation |
url |
string (uri) | |
uuid |
string (uuid) | |
role |
string (uuid) | UUID of the role to grant to the invited user |
created |
string (date-time) | |
is_active |
boolean | |
is_public |
boolean | Allow non-authenticated users to see and accept this invitation. Only staff can create public invitations. |
auto_create_project |
boolean | Create project and grant project permissions instead of customer permissions |
auto_approve |
boolean | Automatically approve permission requests from users matching email patterns or affiliations |
project_name_template |
string | Template for project name. Supports {username}, {email}, {full_name} variables |
project_role |
string (uuid) | UUID of the project role to grant if auto_create_project is enabled |
user_affiliations |
any | |
user_email_patterns |
any | |
user_identity_sources |
any | List of allowed identity sources (identity providers). |
scope_image |
string (uri) | Image URL of the invitation scope (Customer or Project) |
custom_text |
string | Custom description text displayed to users viewing this invitation. |
Update a group invitation
Update an active group invitation. Only active invitations can be edited.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
GroupInvitationUpdateRequest - API Source:
user_group_invitations_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
is_public |
boolean | Allow non-authenticated users to see and accept this invitation. Only staff can create public invitations. | |
role |
string (uuid) | UUID of the role to grant. | |
scope |
string | URL of the scope (Customer or Project) for this invitation | |
auto_create_project |
boolean | Create project and grant project permissions instead of customer permissions | |
auto_approve |
boolean | Automatically approve permission requests from users matching email patterns or affiliations | |
project_name_template |
string | Template for project name. Supports {username}, {email}, {full_name} variables | |
project_role |
string (uuid) | UUID of the project role to grant if auto_create_project is enabled | |
user_affiliations |
any | ||
user_email_patterns |
any | ||
user_identity_sources |
any | List of allowed identity sources (identity providers). | |
custom_text |
string | Custom description text displayed to users viewing this invitation. |
200 -
| Field | Type | Description |
|---|---|---|
is_public |
boolean | Allow non-authenticated users to see and accept this invitation. Only staff can create public invitations. |
role |
string (uuid) | UUID of the role to grant. |
scope |
string | URL of the scope (Customer or Project) for this invitation |
auto_create_project |
boolean | Create project and grant project permissions instead of customer permissions |
auto_approve |
boolean | Automatically approve permission requests from users matching email patterns or affiliations |
project_name_template |
string | Template for project name. Supports {username}, {email}, {full_name} variables |
project_role |
string (uuid) | UUID of the project role to grant if auto_create_project is enabled |
user_affiliations |
any | |
user_email_patterns |
any | |
user_identity_sources |
any | List of allowed identity sources (identity providers). |
custom_text |
string | Custom description text displayed to users viewing this invitation. |
Partially update a group invitation
Partially update an active group invitation. Only active invitations can be edited.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedGroupInvitationUpdateRequest - API Source:
user_group_invitations_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
is_public |
boolean | Allow non-authenticated users to see and accept this invitation. Only staff can create public invitations. | |
role |
string (uuid) | UUID of the role to grant. | |
scope |
string | URL of the scope (Customer or Project) for this invitation | |
auto_create_project |
boolean | Create project and grant project permissions instead of customer permissions | |
auto_approve |
boolean | Automatically approve permission requests from users matching email patterns or affiliations | |
project_name_template |
string | Template for project name. Supports {username}, {email}, {full_name} variables | |
project_role |
string (uuid) | UUID of the project role to grant if auto_create_project is enabled | |
user_affiliations |
any | ||
user_email_patterns |
any | ||
user_identity_sources |
any | List of allowed identity sources (identity providers). | |
custom_text |
string | Custom description text displayed to users viewing this invitation. |
200 -
| Field | Type | Description |
|---|---|---|
is_public |
boolean | Allow non-authenticated users to see and accept this invitation. Only staff can create public invitations. |
role |
string (uuid) | UUID of the role to grant. |
scope |
string | URL of the scope (Customer or Project) for this invitation |
auto_create_project |
boolean | Create project and grant project permissions instead of customer permissions |
auto_approve |
boolean | Automatically approve permission requests from users matching email patterns or affiliations |
project_name_template |
string | Template for project name. Supports {username}, {email}, {full_name} variables |
project_role |
string (uuid) | UUID of the project role to grant if auto_create_project is enabled |
user_affiliations |
any | |
user_email_patterns |
any | |
user_identity_sources |
any | List of allowed identity sources (identity providers). |
custom_text |
string | Custom description text displayed to users viewing this invitation. |
Delete a group invitation
Deletes an inactive group invitation. Only invitations that have been canceled (is_active=False) can be deleted.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
user_group_invitations_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
List projects for a customer-scoped group invitation
For a group invitation scoped to a customer, this endpoint lists all projects within that customer.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- API Source:
user_group_invitations_projects_list
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
uuid |
string (uuid) |
url |
string (uri) |
Cancel a group invitation
Cancels an active group invitation, preventing new permission requests from being created.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
user_group_invitations_cancel
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - No response body
Submit a permission request
Creates a permission request based on a group invitation for the currently authenticated user. If the invitation has auto_approve enabled and the user matches the required patterns, the request is automatically approved.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
user_group_invitations_submit_request
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string | UUID of the created permission request |
scope_name |
string | Name of the invitation scope |
scope_uuid |
string | UUID of the invitation scope |
auto_approved |
boolean | Whether the request was automatically approved |
User Invitations
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/user-invitations/ |
List user invitations |
| GET | /api/user-invitations/{uuid}/ |
Retrieve user invitation |
| POST | /api/user-invitations/ |
Create user invitation |
| PUT | /api/user-invitations/{uuid}/ |
Update user invitation |
| PATCH | /api/user-invitations/{uuid}/ |
Partially update user invitation |
| DELETE | /api/user-invitations/{uuid}/ |
Delete user invitation |
| Other Actions | ||
| GET | /api/user-invitations/{uuid}/details/ |
Get public invitation details |
| POST | /api/user-invitations/{uuid}/accept/ |
Accept an invitation |
| POST | /api/user-invitations/approve/ |
Approve a requested invitation |
| POST | /api/user-invitations/{uuid}/cancel/ |
Cancel an invitation |
| POST | /api/user-invitations/{uuid}/check/ |
Check invitation validity |
| POST | /api/user-invitations/check-duplicates/ |
Check for duplicate invitations |
| POST | /api/user-invitations/{uuid}/delete/ |
Delete an invitation (staff only) |
| POST | /api/user-invitations/reject/ |
Reject a requested invitation |
| POST | /api/user-invitations/{uuid}/send/ |
Resend an invitation |
Core CRUD
List user invitations
Retrieve a list of user invitations visible to the current user.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- Model Source:
InvitationOEnum - Model Source:
InvitationState - API Source:
user_invitations_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
civil_number |
string | |
customer_uuid |
string (uuid) | |
email |
string | |
email_exact |
string | |
o |
array | Ordering |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
role_name |
string | |
role_uuid |
string (uuid) | |
scope |
string (uri) | Filter by scope URL. |
scope_description |
string | |
scope_name |
string | |
scope_type |
string | |
state |
array |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
scope_uuid |
string (uuid) | UUID of the invitation scope (Customer or Project) |
scope_name |
string | Name of the invitation scope |
scope_description |
string | Description of the invitation scope |
scope_type |
string | Type of the invitation scope (e.g., 'customer', 'project') |
customer_uuid |
string (uuid) | UUID of the customer organization |
customer_name |
string | Name of the customer organization |
role_name |
string | Name of the role being granted (e.g., 'PROJECT.ADMIN') |
role_description |
string | Description of the role being granted |
created_by_full_name |
string | Full name of the user who created this invitation |
created_by_username |
string | Username of the user who created this invitation |
created_by_image |
string (uri) | Profile image of the user who created this invitation |
url |
string (uri) | |
uuid |
string (uuid) | |
role |
string (uuid) | UUID of the role to grant to the invited user |
created |
string (date-time) | |
expires |
string (date-time) | Expiration date and time of the invitation |
full_name |
string | |
native_name |
string | |
phone_number |
string | |
organization |
string | |
job_title |
string | |
email |
string (email) | Invitation link will be sent to this email. Note that user can accept invitation with different email. |
civil_number |
string | Civil number of invited user. If civil number is not defined any user can accept invitation. |
state |
any | |
error_message |
string | |
extra_invitation_text |
string | |
execution_state |
any |
Retrieve user invitation
Retrieve details of a specific user invitation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
user_invitations_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
scope_uuid |
string (uuid) | UUID of the invitation scope (Customer or Project) |
scope_name |
string | Name of the invitation scope |
scope_description |
string | Description of the invitation scope |
scope_type |
string | Type of the invitation scope (e.g., 'customer', 'project') |
customer_uuid |
string (uuid) | UUID of the customer organization |
customer_name |
string | Name of the customer organization |
role_name |
string | Name of the role being granted (e.g., 'PROJECT.ADMIN') |
role_description |
string | Description of the role being granted |
created_by_full_name |
string | Full name of the user who created this invitation |
created_by_username |
string | Username of the user who created this invitation |
created_by_image |
string (uri) | Profile image of the user who created this invitation |
url |
string (uri) | |
uuid |
string (uuid) | |
role |
string (uuid) | UUID of the role to grant to the invited user |
created |
string (date-time) | |
expires |
string (date-time) | Expiration date and time of the invitation |
full_name |
string | |
native_name |
string | |
phone_number |
string | |
organization |
string | |
job_title |
string | |
email |
string (email) | Invitation link will be sent to this email. Note that user can accept invitation with different email. |
civil_number |
string | Civil number of invited user. If civil number is not defined any user can accept invitation. |
state |
any | |
error_message |
string | |
extra_invitation_text |
string | |
execution_state |
any |
Create user invitation
Create a new user invitation to grant a role in a specific scope (e.g., organization or project).
1 2 3 4 5 6 7 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
InvitationRequest - API Source:
user_invitations_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
| Field | Type | Required | Description |
|---|---|---|---|
role |
string (uuid) | ✓ | UUID of the role to grant to the invited user |
scope |
string | ✓ | URL of the scope (Customer or Project) for this invitation Constraints: write-only |
full_name |
string | ||
native_name |
string | ||
phone_number |
string | ||
organization |
string | ||
job_title |
string | ||
email |
string (email) | ✓ | Invitation link will be sent to this email. Note that user can accept invitation with different email. |
civil_number |
string | Civil number of invited user. If civil number is not defined any user can accept invitation. | |
extra_invitation_text |
string |
201 -
| Field | Type | Description |
|---|---|---|
scope_uuid |
string (uuid) | UUID of the invitation scope (Customer or Project) |
scope_name |
string | Name of the invitation scope |
scope_description |
string | Description of the invitation scope |
scope_type |
string | Type of the invitation scope (e.g., 'customer', 'project') |
customer_uuid |
string (uuid) | UUID of the customer organization |
customer_name |
string | Name of the customer organization |
role_name |
string | Name of the role being granted (e.g., 'PROJECT.ADMIN') |
role_description |
string | Description of the role being granted |
created_by_full_name |
string | Full name of the user who created this invitation |
created_by_username |
string | Username of the user who created this invitation |
created_by_image |
string (uri) | Profile image of the user who created this invitation |
url |
string (uri) | |
uuid |
string (uuid) | |
role |
string (uuid) | UUID of the role to grant to the invited user |
created |
string (date-time) | |
expires |
string (date-time) | Expiration date and time of the invitation |
full_name |
string | |
native_name |
string | |
phone_number |
string | |
organization |
string | |
job_title |
string | |
email |
string (email) | Invitation link will be sent to this email. Note that user can accept invitation with different email. |
civil_number |
string | Civil number of invited user. If civil number is not defined any user can accept invitation. |
state |
any | |
error_message |
string | |
extra_invitation_text |
string | |
execution_state |
any |
Update user invitation
Update an existing user invitation. Only pending invitations can be edited. Allows changing email and role within the same scope.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
InvitationUpdateRequest - API Source:
user_invitations_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
email |
string (email) | ✓ | Invitation link will be sent to this email. Note that user can accept invitation with different email. |
role |
string (uuid) | UUID of the new role to assign. Must be compatible with the invitation scope. |
200 -
| Field | Type | Description |
|---|---|---|
email |
string (email) | Invitation link will be sent to this email. Note that user can accept invitation with different email. |
role |
string (uuid) | UUID of the new role to assign. Must be compatible with the invitation scope. |
Partially update user invitation
Partially update an existing user invitation. Only pending invitations can be edited. Allows changing email and role within the same scope.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedInvitationUpdateRequest - API Source:
user_invitations_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
email |
string (email) | Invitation link will be sent to this email. Note that user can accept invitation with different email. | |
role |
string (uuid) | UUID of the new role to assign. Must be compatible with the invitation scope. |
200 -
| Field | Type | Description |
|---|---|---|
email |
string (email) | Invitation link will be sent to this email. Note that user can accept invitation with different email. |
role |
string (uuid) | UUID of the new role to assign. Must be compatible with the invitation scope. |
Delete user invitation
Delete a user invitation. Only users with invitation management permissions can delete invitations.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
user_invitations_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
Get public invitation details
Retrieves public-facing details of an invitation. This is used to show information to a user before they accept it.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
user_invitations_details_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
scope_uuid |
string (uuid) | UUID of the invitation scope (Customer or Project) |
scope_name |
string | Name of the invitation scope |
scope_description |
string | Description of the invitation scope |
scope_type |
string | Type of the invitation scope (e.g., 'customer', 'project') |
customer_uuid |
string (uuid) | UUID of the customer organization |
customer_name |
string | Name of the customer organization |
role_name |
string | Name of the role being granted (e.g., 'PROJECT.ADMIN') |
role_description |
string | Description of the role being granted |
created_by_full_name |
string | Full name of the user who created this invitation |
created_by_username |
string | Username of the user who created this invitation |
created_by_image |
string (uri) | Profile image of the user who created this invitation |
email |
string (email) | Invitation link will be sent to this email. Note that user can accept invitation with different email. |
error_message |
string | |
execution_state |
any | |
state |
any | Current state of the invitation (e.g., 'pending', 'accepted', 'rejected') |
Accept an invitation
Accepts an invitation for the currently authenticated user. This grants the user the specified role in the invitation's scope.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
user_invitations_accept
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - No response body
Approve a requested invitation
1 2 | |
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
- Model Source:
TokenRequest - API Source:
user_invitations_approve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Field | Type | Required | Description |
|---|---|---|---|
token |
string | ✓ | Authentication token for invitation acceptance |
200 - No response body
Cancel an invitation
Cancels a pending or planned (pending_project) invitation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
user_invitations_cancel
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
Check invitation validity
Checks if an invitation is pending and returns its email and whether a civil number is required for acceptance. This endpoint is public and does not require authentication.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
user_invitations_check
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
email |
string (email) | Email address to check for existing invitations |
civil_number_required |
boolean | Whether civil number verification is required |
Check for duplicate invitations
Returns pending invitations that already exist for the same email and role within the given scope.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
InvitationDuplicateCheckRequest - API Source:
user_invitations_check_duplicates
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Field | Type | Required | Description |
|---|---|---|---|
scope |
string | ✓ | URL of the scope (Customer or Project) for this invitation list |
invitations |
array of objects | ✓ | |
invitations.email |
string (email) | ✓ | |
invitations.role |
string (uuid) | ✓ | UUID of the role to grant to the invited user |
200 -
| Field | Type |
|---|---|
duplicates |
array of objects |
duplicates.email |
string (email) |
duplicates.role |
string (uuid) |
duplicates.existing_invitation_uuid |
string (uuid) |
Delete an invitation (staff only)
Deletes an invitation. This action is restricted to staff users.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
user_invitations_delete
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - No response body
Reject a requested invitation
1 2 | |
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
- Model Source:
TokenRequest - API Source:
user_invitations_reject
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Field | Type | Required | Description |
|---|---|---|---|
token |
string | ✓ | Authentication token for invitation acceptance |
200 - No response body
Resend an invitation
Resends an email for a pending, expired, or canceled invitation. If the invitation was expired or canceled, its state is reset to 'pending' and its creation time is updated.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
user_invitations_send
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - No response body
User Permission Requests
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/user-permission-requests/ |
List permission requests |
| GET | /api/user-permission-requests/{uuid}/ |
Retrieve permission request |
| Other Actions | ||
| POST | /api/user-permission-requests/{uuid}/approve/ |
Approve a permission request |
| POST | /api/user-permission-requests/{uuid}/cancel_request/ |
Cancel a permission request |
| POST | /api/user-permission-requests/{uuid}/reject/ |
Reject a permission request |
Core CRUD
List permission requests
Retrieve a list of permission requests visible to the user.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- Model Source:
ProposalReviewOEnum - Model Source:
RemoteProjectUpdateRequestStateEnum - API Source:
user_permission_requests_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
created_by |
string (uuid) | |
customer_uuid |
string (uuid) | |
invitation |
string (uuid) | |
o |
array | Ordering |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
scope |
string (uri) | Filter by scope URL. |
state |
array |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
invitation |
string (uri) | |
state |
string | |
created |
string (date-time) | |
created_by_full_name |
string | |
created_by_username |
string | |
created_by_email |
string (email) | |
reviewed_by_full_name |
string | |
reviewed_by_username |
string | |
reviewed_at |
string (date-time) | Timestamp when the review was completed |
review_comment |
string | Optional comment provided during review |
scope_uuid |
string (uuid) | |
scope_name |
string | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
role_name |
string | |
role_description |
string | |
project_name_template |
string |
Retrieve permission request
Retrieve details of a specific permission request.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
user_permission_requests_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
invitation |
string (uri) | |
state |
string | |
created |
string (date-time) | |
created_by_full_name |
string | |
created_by_username |
string | |
created_by_email |
string (email) | |
reviewed_by_full_name |
string | |
reviewed_by_username |
string | |
reviewed_at |
string (date-time) | Timestamp when the review was completed |
review_comment |
string | Optional comment provided during review |
scope_uuid |
string (uuid) | |
scope_name |
string | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
role_name |
string | |
role_description |
string | |
project_name_template |
string |
Other Actions
Approve a permission request
Approves a pending permission request, granting the requesting user the permissions defined in the associated group invitation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
ReviewCommentRequest - API Source:
user_permission_requests_approve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
comment |
string | Optional comment for review |
200 - No response body
Cancel a permission request
Cancels a pending or draft permission request. This can be done by the user who created the request or by a staff member.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
user_permission_requests_cancel_request
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string | UUID of the canceled permission request |
scope_name |
string | Name of the invitation scope |
scope_uuid |
string | UUID of the invitation scope |
Reject a permission request
Rejects a pending permission request.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
ReviewCommentRequest - API Source:
user_permission_requests_reject
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
comment |
string | Optional comment for review |
200 - No response body
User Permissions
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/user-permissions/ |
List user permissions |
| GET | /api/user-permissions/{uuid}/ |
Get permission details |
List user permissions
Get a list of all permissions for the current user. Staff and support users can view all user permissions. The list can be filtered by user, scope, role, etc.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 | |
- Model Source:
OfferingPermissionOEnum - API Source:
user_permissions_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
created |
string (date-time) | Created after |
expiration_time |
string (date-time) | |
full_name |
string | User full name contains |
modified |
string (date-time) | Modified after |
native_name |
string | |
o |
array | Ordering |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
role_name |
string | Role name contains |
role_uuid |
string (uuid) | Role UUID |
scope_name |
string | Scope name |
scope_type |
string | Scope type |
scope_uuid |
string | Scope UUID |
user |
string (uuid) | |
user_slug |
string | User slug contains |
user_url |
string (uri) | |
username |
string |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
user_uuid |
string (uuid) |
user_name |
string |
user_slug |
string |
created |
string (date-time) |
expiration_time |
string (date-time) |
created_by_full_name |
string |
created_by_username |
string |
role_name |
string |
role_description |
string |
role_uuid |
string (uuid) |
scope_type |
string |
scope_uuid |
string (uuid) |
scope_name |
string |
customer_uuid |
string (uuid) |
customer_name |
string |
Get permission details
Retrieve the details of a specific user permission grant by its UUID.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
user_permissions_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
user_uuid |
string (uuid) |
user_name |
string |
user_slug |
string |
created |
string (date-time) |
expiration_time |
string (date-time) |
created_by_full_name |
string |
created_by_username |
string |
role_name |
string |
role_description |
string |
role_uuid |
string (uuid) |
scope_type |
string |
scope_uuid |
string (uuid) |
scope_name |
string |
customer_uuid |
string (uuid) |
customer_name |
string |
Notifications and logging
Admin Announcements
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/admin-announcements/ |
List Admin Announcements |
| GET | /api/admin-announcements/{uuid}/ |
Retrieve |
| POST | /api/admin-announcements/ |
Create |
| PUT | /api/admin-announcements/{uuid}/ |
Update |
| PATCH | /api/admin-announcements/{uuid}/ |
Partial Update |
| DELETE | /api/admin-announcements/{uuid}/ |
Delete |
List Admin Announcements
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
AdminAnnouncementFieldEnum - Model Source:
AdminAnnouncementOEnum - Model Source:
AdminAnnouncementTypeEnum - API Source:
admin_announcements_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
description |
string | |
field |
array | |
is_active |
boolean | |
o |
array | Ordering |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
type |
array |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
uuid |
string (uuid) |
description |
string |
active_from |
string (date-time) |
active_to |
string (date-time) |
is_active |
boolean |
type |
string |
created |
string (date-time) |
maintenance_uuid |
string |
maintenance_name |
string |
maintenance_type |
string |
maintenance_state |
string |
maintenance_scheduled_start |
string (date-time) |
maintenance_scheduled_end |
string (date-time) |
maintenance_service_provider |
string |
maintenance_affected_offerings |
array of objects |
maintenance_affected_offerings.uuid |
string (uuid) |
maintenance_affected_offerings.name |
string |
maintenance_affected_offerings.impact_level |
string |
maintenance_affected_offerings.impact_level_display |
string |
maintenance_affected_offerings.impact_description |
string |
maintenance_external_reference_url |
string |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
AdminAnnouncementFieldEnum - API Source:
admin_announcements_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
description |
string |
active_from |
string (date-time) |
active_to |
string (date-time) |
is_active |
boolean |
type |
string |
created |
string (date-time) |
maintenance_uuid |
string |
maintenance_name |
string |
maintenance_type |
string |
maintenance_state |
string |
maintenance_scheduled_start |
string (date-time) |
maintenance_scheduled_end |
string (date-time) |
maintenance_service_provider |
string |
maintenance_affected_offerings |
array of objects |
maintenance_affected_offerings.uuid |
string (uuid) |
maintenance_affected_offerings.name |
string |
maintenance_affected_offerings.impact_level |
string |
maintenance_affected_offerings.impact_level_display |
string |
maintenance_affected_offerings.impact_description |
string |
maintenance_external_reference_url |
string |
Create
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
AdminAnnouncementRequest - API Source:
admin_announcements_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Field | Type | Required |
|---|---|---|
description |
string | |
active_from |
string (date-time) | ✓ |
active_to |
string (date-time) | ✓ |
type |
string |
201 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
description |
string |
active_from |
string (date-time) |
active_to |
string (date-time) |
is_active |
boolean |
type |
string |
created |
string (date-time) |
maintenance_uuid |
string |
maintenance_name |
string |
maintenance_type |
string |
maintenance_state |
string |
maintenance_scheduled_start |
string (date-time) |
maintenance_scheduled_end |
string (date-time) |
maintenance_service_provider |
string |
maintenance_affected_offerings |
array of objects |
maintenance_affected_offerings.uuid |
string (uuid) |
maintenance_affected_offerings.name |
string |
maintenance_affected_offerings.impact_level |
string |
maintenance_affected_offerings.impact_level_display |
string |
maintenance_affected_offerings.impact_description |
string |
maintenance_external_reference_url |
string |
Update
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
AdminAnnouncementRequest - API Source:
admin_announcements_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
description |
string | |
active_from |
string (date-time) | ✓ |
active_to |
string (date-time) | ✓ |
type |
string |
200 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
description |
string |
active_from |
string (date-time) |
active_to |
string (date-time) |
is_active |
boolean |
type |
string |
created |
string (date-time) |
maintenance_uuid |
string |
maintenance_name |
string |
maintenance_type |
string |
maintenance_state |
string |
maintenance_scheduled_start |
string (date-time) |
maintenance_scheduled_end |
string (date-time) |
maintenance_service_provider |
string |
maintenance_affected_offerings |
array of objects |
maintenance_affected_offerings.uuid |
string (uuid) |
maintenance_affected_offerings.name |
string |
maintenance_affected_offerings.impact_level |
string |
maintenance_affected_offerings.impact_level_display |
string |
maintenance_affected_offerings.impact_description |
string |
maintenance_external_reference_url |
string |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedAdminAnnouncementRequest - API Source:
admin_announcements_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
description |
string | |
active_from |
string (date-time) | |
active_to |
string (date-time) | |
type |
string |
200 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
description |
string |
active_from |
string (date-time) |
active_to |
string (date-time) |
is_active |
boolean |
type |
string |
created |
string (date-time) |
maintenance_uuid |
string |
maintenance_name |
string |
maintenance_type |
string |
maintenance_state |
string |
maintenance_scheduled_start |
string (date-time) |
maintenance_scheduled_end |
string (date-time) |
maintenance_service_provider |
string |
maintenance_affected_offerings |
array of objects |
maintenance_affected_offerings.uuid |
string (uuid) |
maintenance_affected_offerings.name |
string |
maintenance_affected_offerings.impact_level |
string |
maintenance_affected_offerings.impact_level_display |
string |
maintenance_affected_offerings.impact_description |
string |
maintenance_external_reference_url |
string |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
admin_announcements_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Broadcast Message Templates
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/broadcast-message-templates/ |
List Broadcast Message Templates |
| GET | /api/broadcast-message-templates/{uuid}/ |
Retrieve |
| POST | /api/broadcast-message-templates/ |
Create |
| PUT | /api/broadcast-message-templates/{uuid}/ |
Update |
| PATCH | /api/broadcast-message-templates/{uuid}/ |
Partial Update |
| DELETE | /api/broadcast-message-templates/{uuid}/ |
Delete |
List Broadcast Message Templates
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
broadcast_message_templates_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
name |
string | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
subject |
string |
body |
string |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
broadcast_message_templates_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
subject |
string |
body |
string |
Create
1 2 3 4 5 6 7 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
MessageTemplateRequest - API Source:
broadcast_message_templates_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
| Field | Type | Required |
|---|---|---|
name |
string | ✓ |
subject |
string | ✓ |
body |
string | ✓ |
201 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
subject |
string |
body |
string |
Update
1 2 3 4 5 6 7 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | |
- Model Source:
MessageTemplateRequest - API Source:
broadcast_message_templates_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
name |
string | ✓ |
subject |
string | ✓ |
body |
string | ✓ |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
subject |
string |
body |
string |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedMessageTemplateRequest - API Source:
broadcast_message_templates_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
name |
string | |
subject |
string | |
body |
string |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
subject |
string |
body |
string |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
broadcast_message_templates_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Broadcast Messages
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/broadcast-messages/ |
List Broadcast Messages |
| GET | /api/broadcast-messages/{uuid}/ |
Retrieve |
| POST | /api/broadcast-messages/ |
Create |
| PUT | /api/broadcast-messages/{uuid}/ |
Update |
| PATCH | /api/broadcast-messages/{uuid}/ |
Partial Update |
| DELETE | /api/broadcast-messages/{uuid}/ |
Delete |
| Other Actions | ||
| GET | /api/broadcast-messages/recipients/ |
List Broadcast Messages Recipients |
| POST | /api/broadcast-messages/{uuid}/schedule/ |
Schedule |
| POST | /api/broadcast-messages/{uuid}/send/ |
Send |
Core CRUD
List Broadcast Messages
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
BroadcastMessageFieldEnum - Model Source:
BroadcastMessageOEnum - Model Source:
BroadcastMessageStateEnum - API Source:
broadcast_messages_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
field |
array | |
o |
array | Ordering |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
state |
string | Enum: DRAFT, SCHEDULED, SENT |
subject |
string |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
uuid |
string (uuid) |
created |
string (date-time) |
subject |
string |
body |
string |
query |
any |
author_full_name |
string |
emails |
any |
state |
any |
send_at |
string (date) |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
BroadcastMessageFieldEnum - API Source:
broadcast_messages_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
created |
string (date-time) |
subject |
string |
body |
string |
query |
any |
author_full_name |
string |
emails |
any |
state |
any |
send_at |
string (date) |
Create
1 2 3 4 5 6 7 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
BroadcastMessageRequest - API Source:
broadcast_messages_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
| Field | Type | Required |
|---|---|---|
subject |
string | ✓ |
body |
string | ✓ |
query |
any | ✓ |
send_at |
string (date) |
201 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
created |
string (date-time) |
subject |
string |
body |
string |
query |
any |
author_full_name |
string |
emails |
any |
state |
any |
send_at |
string (date) |
Update
1 2 3 4 5 6 7 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | |
- Model Source:
BroadcastMessageRequest - API Source:
broadcast_messages_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
subject |
string | ✓ |
body |
string | ✓ |
query |
any | ✓ |
send_at |
string (date) |
200 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
created |
string (date-time) |
subject |
string |
body |
string |
query |
any |
author_full_name |
string |
emails |
any |
state |
any |
send_at |
string (date) |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedBroadcastMessageRequest - API Source:
broadcast_messages_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
subject |
string | |
body |
string | |
query |
any | |
send_at |
string (date) |
200 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
created |
string (date-time) |
subject |
string |
body |
string |
query |
any |
author_full_name |
string |
emails |
any |
state |
any |
send_at |
string (date) |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
broadcast_messages_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
List Broadcast Messages Recipients
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- Model Source:
BroadcastMessageFieldEnum - API Source:
broadcast_messages_recipients_retrieve
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
created |
string (date-time) |
subject |
string |
body |
string |
query |
any |
author_full_name |
string |
emails |
any |
state |
any |
send_at |
string (date) |
Schedule
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
broadcast_messages_schedule
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - No response body
Send
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
broadcast_messages_send
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - No response body
Data Access Logs
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/data-access-logs/ |
List Data Access Logs |
| GET | /api/data-access-logs/{uuid}/ |
Retrieve |
| DELETE | /api/data-access-logs/{uuid}/ |
Delete |
List Data Access Logs
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- Model Source:
AccessorTypeEnum - Model Source:
GlobalUserDataAccessLogOEnum - API Source:
data_access_logs_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
accessor_type |
string | Type of accessor Enum: staff, support, organization_member, service_provider, self |
accessor_uuid |
string (uuid) | |
end_date |
string (date) | |
o |
array | Ordering |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
query |
string | |
start_date |
string (date) | |
user_uuid |
string (uuid) |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
timestamp |
string (date-time) | |
accessor_type |
string | Enum: staff, support, organization_member, service_provider, self |
accessed_fields |
array of strings | |
user |
object | |
user.uuid |
string (uuid) | |
user.username |
string | |
user.full_name |
string | |
accessor |
object | |
accessor.uuid |
string (uuid) | |
accessor.username |
string | |
accessor.full_name |
string | |
ip_address |
any | An IPv4 or IPv6 address. |
context |
object (free-form) |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
data_access_logs_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
timestamp |
string (date-time) | |
accessor_type |
string | Enum: staff, support, organization_member, service_provider, self |
accessed_fields |
array of strings | |
user |
object | |
user.uuid |
string (uuid) | |
user.username |
string | |
user.full_name |
string | |
accessor |
object | |
accessor.uuid |
string (uuid) | |
accessor.username |
string | |
accessor.full_name |
string | |
ip_address |
any | An IPv4 or IPv6 address. |
context |
object (free-form) |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
data_access_logs_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Email Logs
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/email-logs/ |
List Email Logs |
| GET | /api/email-logs/{uuid}/ |
Retrieve |
List Email Logs
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 | |
- Model Source:
EmailLogOEnum - API Source:
email_logs_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
body |
string | |
emails |
string | |
o |
array | Ordering |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
sent_at |
string (date) | |
subject |
string |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
uuid |
string (uuid) |
url |
string (uri) |
sent_at |
string (date-time) |
subject |
string |
body |
string |
emails |
array of string (email)s |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
email_logs_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
url |
string (uri) |
sent_at |
string (date-time) |
subject |
string |
body |
string |
emails |
array of string (email)s |
Event Subscription Queues
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/event-subscription-queues/ |
List Event Subscription Queues |
| GET | /api/event-subscription-queues/{uuid}/ |
Retrieve |
| DELETE | /api/event-subscription-queues/{uuid}/ |
Delete |
List Event Subscription Queues
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 | |
- Model Source:
BackendResourceReqOEnum - API Source:
event_subscription_queues_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
event_subscription_uuid |
string (uuid) | |
o |
array | Ordering |
object_type |
string | |
offering_uuid |
string (uuid) | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
event_subscription |
string (uri) | |
event_subscription_uuid |
string | |
offering_uuid |
string | |
object_type |
string | Observable object type (e.g., 'resource', 'order') |
queue_name |
string | |
vhost |
string | |
created |
string (date-time) |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
event_subscription_queues_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
event_subscription |
string (uri) | |
event_subscription_uuid |
string | |
offering_uuid |
string | |
object_type |
string | Observable object type (e.g., 'resource', 'order') |
queue_name |
string | |
vhost |
string | |
created |
string (date-time) |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
event_subscription_queues_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Event Subscriptions
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/event-subscriptions/ |
List Event Subscriptions |
| GET | /api/event-subscriptions/{uuid}/ |
Retrieve |
| POST | /api/event-subscriptions/ |
Create |
| POST | /api/event-subscriptions/{uuid}/create_queue/ |
Create queue |
| DELETE | /api/event-subscriptions/{uuid}/ |
Delete |
List Event Subscriptions
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 | |
- Model Source:
BackendResourceReqOEnum - API Source:
event_subscriptions_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
o |
array | Ordering |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
user_username |
string | |
user_uuid |
string |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
description |
string | |
user |
string (uri) | |
user_uuid |
string (uuid) | |
user_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
user_full_name |
string | |
observable_objects |
any | List of objects to observe. Each item must have 'object_type' (one of: order, user_role, resource, offering_user, importable_resources, service_account, course_account, resource_periodic_limits) and optionally 'object_id' (integer). Example: [{"object_type": "resource"}, {"object_type": "order", "object_id": 123}] |
created |
string (date-time) | |
modified |
string (date-time) | |
source_ip |
any | An IPv4 or IPv6 address. |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
event_subscriptions_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
description |
string | |
user |
string (uri) | |
user_uuid |
string (uuid) | |
user_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
user_full_name |
string | |
observable_objects |
any | List of objects to observe. Each item must have 'object_type' (one of: order, user_role, resource, offering_user, importable_resources, service_account, course_account, resource_periodic_limits) and optionally 'object_id' (integer). Example: [{"object_type": "resource"}, {"object_type": "order", "object_id": 123}] |
created |
string (date-time) | |
modified |
string (date-time) | |
source_ip |
any | An IPv4 or IPv6 address. |
Create
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
- Model Source:
EventSubscriptionRequest - API Source:
event_subscriptions_create
1 2 3 4 5 6 7 8 9 10 | |
| Field | Type | Required | Description |
|---|---|---|---|
description |
string | ||
observable_objects |
any | List of objects to observe. Each item must have 'object_type' (one of: order, user_role, resource, offering_user, importable_resources, service_account, course_account, resource_periodic_limits) and optionally 'object_id' (integer). Example: [{"object_type": "resource"}, {"object_type": "order", "object_id": 123}] |
201 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
description |
string | |
user |
string (uri) | |
user_uuid |
string (uuid) | |
user_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
user_full_name |
string | |
observable_objects |
any | List of objects to observe. Each item must have 'object_type' (one of: order, user_role, resource, offering_user, importable_resources, service_account, course_account, resource_periodic_limits) and optionally 'object_id' (integer). Example: [{"object_type": "resource"}, {"object_type": "order", "object_id": 123}] |
created |
string (date-time) | |
modified |
string (date-time) | |
source_ip |
any | An IPv4 or IPv6 address. |
Create queue
Create a RabbitMQ queue for receiving events for a specific offering and object type. The receiver must call this endpoint before subscribing via STOMP to ensure the queue is created with correct arguments (DLX, max-length, etc.).
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
EventSubscriptionQueueCreateRequest - API Source:
event_subscriptions_create_queue
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
offering_uuid |
string (uuid) | ✓ | UUID of the offering to receive events for |
object_type |
any | ✓ | Type of observable object (e.g., 'resource', 'order') |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
event_subscription |
string (uri) | |
event_subscription_uuid |
string | |
offering_uuid |
string | |
object_type |
string | Observable object type (e.g., 'resource', 'order') |
queue_name |
string | |
vhost |
string | |
created |
string (date-time) |
201 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
event_subscription |
string (uri) | |
event_subscription_uuid |
string | |
offering_uuid |
string | |
object_type |
string | Observable object type (e.g., 'resource', 'order') |
queue_name |
string | |
vhost |
string | |
created |
string (date-time) |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
event_subscriptions_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Events Stats
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/events-stats/ |
List Events Stats |
List Events Stats
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
events_stats_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
event_type |
array | Filter by event type. Can be specified multiple times. |
feature |
array | Filter by feature (event group). Can be specified multiple times. |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
scope |
string (uri) | Filter by scope URL. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
year |
integer |
month |
integer |
count |
integer |
Events
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/events/ |
List Events |
| GET | /api/events/{id}/ |
Retrieve |
| Other Actions | ||
| GET | /api/events/count/ |
List Events Count |
| GET | /api/events/event_groups/ |
Returns a list of groups with event types |
| GET | /api/events/scope_types/ |
Returns a list of scope types acceptable by events filter |
Core CRUD
List Events
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- Model Source:
BackendResourceReqOEnum - Model Source:
EventFieldEnum - API Source:
events_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
created_from |
number | |
created_to |
number | |
customer_uuid |
string (uuid) | Customer UUID |
event_type |
array | Filter by event type. Can be specified multiple times. |
feature |
array | Filter by feature (event group). Can be specified multiple times. |
field |
array | |
message |
string | |
o |
array | Ordering |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
project_uuid |
string (uuid) | Project UUID |
scope |
string (uri) | Filter by scope URL. |
user_uuid |
string (uuid) | User UUID |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
uuid |
string (uuid) |
created |
string (date-time) |
event_type |
string |
message |
string |
context |
any |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
EventFieldEnum - API Source:
events_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required | Description |
|---|---|---|---|
id |
integer | ✓ | A unique integer value identifying this event. |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
created |
string (date-time) |
event_type |
string |
message |
string |
context |
any |
Other Actions
List Events Count
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- Model Source:
EventFieldEnum - API Source:
events_count_retrieve
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
created |
string (date-time) |
event_type |
string |
message |
string |
context |
any |
Returns a list of groups with event types
Returns a list of groups with event types. Group is used in exclude_features query param.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- Model Source:
EventFieldEnum - API Source:
events_event_groups_retrieve
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
created |
string (date-time) |
event_type |
string |
message |
string |
context |
any |
Returns a list of scope types acceptable by events filter
Returns a list of scope types acceptable by events filter.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- Model Source:
EventFieldEnum - API Source:
events_scope_types_retrieve
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
created |
string (date-time) |
event_type |
string |
message |
string |
context |
any |
Hooks Email
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/hooks-email/ |
List Hooks Email |
| GET | /api/hooks-email/{uuid}/ |
Retrieve |
| POST | /api/hooks-email/ |
Create |
| PUT | /api/hooks-email/{uuid}/ |
Update |
| PATCH | /api/hooks-email/{uuid}/ |
Partial Update |
| DELETE | /api/hooks-email/{uuid}/ |
Delete |
List Hooks Email
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
hooks_email_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
author_email |
string | |
author_fullname |
string | User full name contains |
author_username |
string | |
author_uuid |
string (uuid) | |
email |
string | |
is_active |
boolean | |
last_published |
string (date-time) | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
query |
string | Filter by author name, username and email |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
is_active |
boolean |
author_uuid |
string (uuid) |
event_types |
array of strings |
event_groups |
array of strings |
created |
string (date-time) |
modified |
string (date-time) |
hook_type |
string |
author_fullname |
string |
author_username |
string |
author_email |
string |
email |
string (email) |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
hooks_email_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
is_active |
boolean |
author_uuid |
string (uuid) |
event_types |
array of strings |
event_groups |
array of strings |
created |
string (date-time) |
modified |
string (date-time) |
hook_type |
string |
author_fullname |
string |
author_username |
string |
author_email |
string |
email |
string (email) |
Create
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
- Model Source:
EmailHookRequest - API Source:
hooks_email_create
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Field | Type | Required |
|---|---|---|
is_active |
boolean | |
event_types |
array of strings | |
event_groups |
array of strings | |
email |
string (email) | ✓ |
201 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
is_active |
boolean |
author_uuid |
string (uuid) |
event_types |
array of strings |
event_groups |
array of strings |
created |
string (date-time) |
modified |
string (date-time) |
hook_type |
string |
author_fullname |
string |
author_username |
string |
author_email |
string |
email |
string (email) |
Update
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
EmailHookRequest - API Source:
hooks_email_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
is_active |
boolean | |
event_types |
array of strings | |
event_groups |
array of strings | |
email |
string (email) | ✓ |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
is_active |
boolean |
author_uuid |
string (uuid) |
event_types |
array of strings |
event_groups |
array of strings |
created |
string (date-time) |
modified |
string (date-time) |
hook_type |
string |
author_fullname |
string |
author_username |
string |
author_email |
string |
email |
string (email) |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedEmailHookRequest - API Source:
hooks_email_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
is_active |
boolean | |
event_types |
array of strings | |
event_groups |
array of strings | |
email |
string (email) |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
is_active |
boolean |
author_uuid |
string (uuid) |
event_types |
array of strings |
event_groups |
array of strings |
created |
string (date-time) |
modified |
string (date-time) |
hook_type |
string |
author_fullname |
string |
author_username |
string |
author_email |
string |
email |
string (email) |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
hooks_email_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Hooks Web
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/hooks-web/ |
List Hooks Web |
| GET | /api/hooks-web/{uuid}/ |
Retrieve |
| POST | /api/hooks-web/ |
Create |
| PUT | /api/hooks-web/{uuid}/ |
Update |
| PATCH | /api/hooks-web/{uuid}/ |
Partial Update |
| DELETE | /api/hooks-web/{uuid}/ |
Delete |
List Hooks Web
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 | |
- Model Source:
WebHookContentTypeEnum1 - API Source:
hooks_web_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
author_email |
string | |
author_fullname |
string | User full name contains |
author_username |
string | |
author_uuid |
string (uuid) | |
content_type |
string | Enum: 1, 2 |
destination_url |
string | |
is_active |
boolean | |
last_published |
string (date-time) | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
query |
string | Filter by author name, username and email |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
is_active |
boolean |
author_uuid |
string (uuid) |
event_types |
array of strings |
event_groups |
array of strings |
created |
string (date-time) |
modified |
string (date-time) |
hook_type |
string |
author_fullname |
string |
author_username |
string |
author_email |
string |
destination_url |
string (uri) |
content_type |
string |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
hooks_web_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
is_active |
boolean |
author_uuid |
string (uuid) |
event_types |
array of strings |
event_groups |
array of strings |
created |
string (date-time) |
modified |
string (date-time) |
hook_type |
string |
author_fullname |
string |
author_username |
string |
author_email |
string |
destination_url |
string (uri) |
content_type |
string |
Create
When hook is activated, POST request is issued against destination URL with the following data:
.. code-block:: javascript
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
Note that context depends on event type.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
- Model Source:
WebHookRequest - API Source:
hooks_web_create
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Field | Type | Required |
|---|---|---|
is_active |
boolean | |
event_types |
array of strings | |
event_groups |
array of strings | |
destination_url |
string (uri) | ✓ |
content_type |
string |
201 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
is_active |
boolean |
author_uuid |
string (uuid) |
event_types |
array of strings |
event_groups |
array of strings |
created |
string (date-time) |
modified |
string (date-time) |
hook_type |
string |
author_fullname |
string |
author_username |
string |
author_email |
string |
destination_url |
string (uri) |
content_type |
string |
Update
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
WebHookRequest - API Source:
hooks_web_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
is_active |
boolean | |
event_types |
array of strings | |
event_groups |
array of strings | |
destination_url |
string (uri) | ✓ |
content_type |
string |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
is_active |
boolean |
author_uuid |
string (uuid) |
event_types |
array of strings |
event_groups |
array of strings |
created |
string (date-time) |
modified |
string (date-time) |
hook_type |
string |
author_fullname |
string |
author_username |
string |
author_email |
string |
destination_url |
string (uri) |
content_type |
string |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedWebHookRequest - API Source:
hooks_web_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
is_active |
boolean | |
event_types |
array of strings | |
event_groups |
array of strings | |
destination_url |
string (uri) | |
content_type |
string |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
is_active |
boolean |
author_uuid |
string (uuid) |
event_types |
array of strings |
event_groups |
array of strings |
created |
string (date-time) |
modified |
string (date-time) |
hook_type |
string |
author_fullname |
string |
author_username |
string |
author_email |
string |
destination_url |
string (uri) |
content_type |
string |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
hooks_web_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Hooks
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/hooks/ |
List Hooks |
List Hooks
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
- API Source:
hooks_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
author_uuid |
string (uuid) | Filter by author UUID. |
is_active |
boolean | Filter by active status. |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 - No response body
Notification Messages Templates
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/notification-messages-templates/ |
List Notification Messages Templates |
| GET | /api/notification-messages-templates/{uuid}/ |
Retrieve |
| POST | /api/notification-messages-templates/ |
Create |
| PUT | /api/notification-messages-templates/{uuid}/ |
Update |
| PATCH | /api/notification-messages-templates/{uuid}/ |
Partial Update |
| DELETE | /api/notification-messages-templates/{uuid}/ |
Delete |
| Other Actions | ||
| POST | /api/notification-messages-templates/{uuid}/override/ |
Override notification template content |
Core CRUD
List Notification Messages Templates
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
notification_messages_templates_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
is_overridden |
boolean | Is overridden |
name |
string | Name |
name_exact |
string | Name (exact) |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
path |
string | Path |
path_exact |
string | Path (exact) |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
path |
string | Example: 'flatpages/default.html' |
name |
string | |
content |
string | |
original_content |
string | |
is_content_overridden |
boolean |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
notification_messages_templates_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
path |
string | Example: 'flatpages/default.html' |
name |
string | |
content |
string | |
original_content |
string | |
is_content_overridden |
boolean |
Create
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
NotificationTemplateDetailSerializersRequest - API Source:
notification_messages_templates_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Field | Type | Required | Description |
|---|---|---|---|
path |
string | ✓ | Example: 'flatpages/default.html' |
name |
string | ✓ |
201 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
path |
string | Example: 'flatpages/default.html' |
name |
string | |
content |
string | |
original_content |
string | |
is_content_overridden |
boolean |
Update
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
NotificationTemplateDetailSerializersRequest - API Source:
notification_messages_templates_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
path |
string | ✓ | Example: 'flatpages/default.html' |
name |
string | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
path |
string | Example: 'flatpages/default.html' |
name |
string | |
content |
string | |
original_content |
string | |
is_content_overridden |
boolean |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedNotificationTemplateDetailSerializersRequest - API Source:
notification_messages_templates_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
path |
string | Example: 'flatpages/default.html' | |
name |
string |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
path |
string | Example: 'flatpages/default.html' |
name |
string | |
content |
string | |
original_content |
string | |
is_content_overridden |
boolean |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
notification_messages_templates_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
Override notification template content
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
NotificationTemplateUpdateSerializersRequest - API Source:
notification_messages_templates_override
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
content |
string | ✓ |
200 - No response body
Notification Messages
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/notification-messages/ |
List Notification Messages |
| GET | /api/notification-messages/{uuid}/ |
Retrieve |
| POST | /api/notification-messages/ |
Create |
| PUT | /api/notification-messages/{uuid}/ |
Update |
| PATCH | /api/notification-messages/{uuid}/ |
Partial Update |
| DELETE | /api/notification-messages/{uuid}/ |
Delete |
| Other Actions | ||
| POST | /api/notification-messages/{uuid}/disable/ |
Disable a notification |
| POST | /api/notification-messages/{uuid}/enable/ |
Enable a notification |
Core CRUD
List Notification Messages
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
notification_messages_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
description |
string | |
is_overridden |
boolean | Is overridden |
key |
string | |
name |
string | Name |
name_exact |
string | Name (exact) |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
query |
string | Filter by key or description |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
key |
string | |
description |
string | |
enabled |
boolean | Indicates if notification is enabled or disabled |
created |
string (date-time) | |
templates |
array of objects | |
templates.uuid |
string (uuid) | |
templates.url |
string (uri) | |
templates.path |
string | Example: 'flatpages/default.html' |
templates.name |
string | |
templates.content |
string | |
templates.original_content |
string | |
templates.is_content_overridden |
boolean | |
context_schema |
object (free-form) | Finds the notification definition in the global NOTIFICATIONS dictionary and returns its 'context' schema. |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
notification_messages_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
key |
string | |
description |
string | |
enabled |
boolean | Indicates if notification is enabled or disabled |
created |
string (date-time) | |
templates |
array of objects | |
templates.uuid |
string (uuid) | |
templates.url |
string (uri) | |
templates.path |
string | Example: 'flatpages/default.html' |
templates.name |
string | |
templates.content |
string | |
templates.original_content |
string | |
templates.is_content_overridden |
boolean | |
context_schema |
object (free-form) | Finds the notification definition in the global NOTIFICATIONS dictionary and returns its 'context' schema. |
Create
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
- Model Source:
NotificationRequest - API Source:
notification_messages_create
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Field | Type | Required |
|---|---|---|
key |
string | ✓ |
description |
string |
201 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
key |
string | |
description |
string | |
enabled |
boolean | Indicates if notification is enabled or disabled |
created |
string (date-time) | |
templates |
array of objects | |
templates.uuid |
string (uuid) | |
templates.url |
string (uri) | |
templates.path |
string | Example: 'flatpages/default.html' |
templates.name |
string | |
templates.content |
string | |
templates.original_content |
string | |
templates.is_content_overridden |
boolean | |
context_schema |
object (free-form) | Finds the notification definition in the global NOTIFICATIONS dictionary and returns its 'context' schema. |
Update
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
NotificationRequest - API Source:
notification_messages_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
key |
string | ✓ |
description |
string |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
key |
string | |
description |
string | |
enabled |
boolean | Indicates if notification is enabled or disabled |
created |
string (date-time) | |
templates |
array of objects | |
templates.uuid |
string (uuid) | |
templates.url |
string (uri) | |
templates.path |
string | Example: 'flatpages/default.html' |
templates.name |
string | |
templates.content |
string | |
templates.original_content |
string | |
templates.is_content_overridden |
boolean | |
context_schema |
object (free-form) | Finds the notification definition in the global NOTIFICATIONS dictionary and returns its 'context' schema. |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedNotificationRequest - API Source:
notification_messages_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
key |
string | |
description |
string |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
key |
string | |
description |
string | |
enabled |
boolean | Indicates if notification is enabled or disabled |
created |
string (date-time) | |
templates |
array of objects | |
templates.uuid |
string (uuid) | |
templates.url |
string (uri) | |
templates.path |
string | Example: 'flatpages/default.html' |
templates.name |
string | |
templates.content |
string | |
templates.original_content |
string | |
templates.is_content_overridden |
boolean | |
context_schema |
object (free-form) | Finds the notification definition in the global NOTIFICATIONS dictionary and returns its 'context' schema. |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
notification_messages_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
Disable a notification
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
notification_messages_disable
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - No response body
Enable a notification
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
notification_messages_enable
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - No response body
Rabbitmq Overview
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/rabbitmq-overview/ |
Get RabbitMQ cluster overview statistics |
Get RabbitMQ cluster overview statistics
Returns global RabbitMQ cluster health and performance metrics.
Includes: - Cluster info: Name, RabbitMQ version, Erlang version - Message stats: Publish/deliver/confirm/ack counts and rates (per second) - Queue totals: Total messages, ready messages, unacknowledged messages - Object totals: Connection, channel, exchange, queue, and consumer counts - Listeners: Active protocol listeners (AMQP, HTTP, etc.)
Requires support user permissions.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
- API Source:
rabbitmq_overview_retrieve
1 2 3 4 5 6 7 8 9 10 | |
200 -
| Field | Type | Description |
|---|---|---|
cluster_name |
string | Name of the RabbitMQ cluster |
rabbitmq_version |
string | RabbitMQ server version |
erlang_version |
string | Erlang/OTP runtime version |
message_stats |
any | Message throughput statistics with rates |
queue_totals |
any | Global queue message counts |
object_totals |
any | Counts of connections, channels, queues, etc. |
node |
string | Current RabbitMQ node name |
listeners |
array of objects | Active protocol listeners |
listeners.protocol |
string | Protocol name (e.g., 'amqp', 'http', 'clustering') |
listeners.port |
integer | Listening port number |
503 -
| Field | Type | Description |
|---|---|---|
error |
string | Error message describing what went wrong |
Rabbitmq Stats
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/rabbitmq-stats/ |
Get RabbitMQ subscription queue statistics |
| Other Actions | ||
| POST | /api/rabbitmq-stats/ |
Purge or delete RabbitMQ subscription queues |
Core CRUD
Get RabbitMQ subscription queue statistics
Provides statistics about RabbitMQ subscription queues.
Returns information about all vhosts with their subscription queues, including: - Queue names and message counts - Waldur user and subscription information linked to each vhost - Total message counts per vhost and across all vhosts
Requires support user permissions.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
- API Source:
rabbitmq_stats_retrieve
1 2 3 4 5 6 7 8 9 10 | |
200 -
| Field | Type | Description |
|---|---|---|
vhosts |
array of objects | List of vhosts with their subscription queues |
vhosts.name |
string | Virtual host name (corresponds to Waldur user UUID) |
vhosts.user |
any | Waldur user associated with this vhost |
vhosts.queues |
array of objects | List of subscription queues in this vhost |
vhosts.queues.name |
string | Queue name (e.g., 'subscription_{uuid}offering')}_{type |
vhosts.queues.messages |
integer | Total number of messages in the queue |
vhosts.queues.messages_ready |
integer | Number of messages ready for delivery |
vhosts.queues.messages_unacknowledged |
integer | Number of messages awaiting acknowledgement |
vhosts.queues.consumers |
integer | Number of active consumers for this queue |
vhosts.queues.subscription_uuid |
string | Parsed subscription UUID from queue name |
vhosts.queues.offering_uuid |
string | Parsed offering UUID from queue name |
vhosts.queues.object_type |
string | Parsed object type from queue name (e.g., 'resource', 'order') |
vhosts.queues.message_ttl |
integer | Message TTL in milliseconds |
vhosts.queues.max_length |
integer | Maximum number of messages in queue |
vhosts.queues.max_length_bytes |
integer | Maximum total size of messages in bytes |
vhosts.queues.expires |
integer | Queue TTL - auto-delete after idle in milliseconds |
vhosts.queues.overflow |
string | Behavior when full: 'drop-head', 'reject-publish', or 'reject-publish-dlx' |
vhosts.queues.dead_letter_exchange |
string | Dead letter exchange name |
vhosts.queues.dead_letter_routing_key |
string | Dead letter routing key |
vhosts.queues.max_priority |
integer | Maximum priority level (1-255) |
vhosts.queues.queue_mode |
string | Queue mode: 'default' or 'lazy' |
vhosts.queues.queue_type |
string | Queue type: 'classic', 'quorum', or 'stream' |
vhosts.total_messages |
integer | Total messages across all queues in this vhost |
total_messages |
integer | Total messages across all subscription queues |
total_queues |
integer | Total number of subscription queues |
503 -
| Field | Type | Description |
|---|---|---|
error |
string | Error message describing what went wrong |
Other Actions
Purge or delete RabbitMQ subscription queues
Purges messages from or deletes specified RabbitMQ subscription queues.
Purge operations (remove messages, keep queue):
- vhost and queue_name: Purge a specific queue
- vhost and queue_pattern: Purge queues matching pattern (e.g., '*_resource')
- purge_all_subscription_queues: Purge all subscription queues across all vhosts
Delete operations (remove queue entirely):
- vhost, queue_name, and delete_queue=true: Delete a specific queue
- vhost, queue_pattern, and delete_queue=true: Delete queues matching pattern
- delete_all_subscription_queues: Delete all subscription queues across all vhosts
Requires staff permissions (more restrictive than viewing).
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
- Model Source:
RmqPurgeRequestRequest - API Source:
rabbitmq_stats
1 2 3 4 5 6 7 8 9 10 | |
| Field | Type | Required | Description |
|---|---|---|---|
vhost |
string | Virtual host name containing the queue(s) | |
queue_name |
string | Specific queue name (requires vhost) | |
queue_pattern |
string | Glob pattern to match queue names (e.g., '*_resource'). Requires vhost. | |
purge_all_subscription_queues |
boolean | If true, purge all subscription queues across all vhosts Constraints: default: False |
|
delete_queue |
boolean | If true, delete the queue(s) entirely instead of just purging messages Constraints: default: False |
|
delete_all_subscription_queues |
boolean | If true, delete all subscription queues across all vhosts Constraints: default: False |
200 -
| Field | Type | Description |
|---|---|---|
purged_queues |
integer | Number of queues that were purged |
purged_messages |
integer | Total number of messages that were purged |
deleted_queues |
integer | Number of queues that were deleted |
400 -
| Field | Type | Description |
|---|---|---|
error |
string | Error message describing what went wrong |
404 -
| Field | Type | Description |
|---|---|---|
error |
string | Error message describing what went wrong |
503 -
| Field | Type | Description |
|---|---|---|
error |
string | Error message describing what went wrong |
Rabbitmq User Stats
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/rabbitmq-user-stats/ |
Get RabbitMQ user connection statistics |
Get RabbitMQ user connection statistics
Returns enriched connection data for all RabbitMQ users.
For each user (which corresponds to an EventSubscription), provides: - Connection state (running, blocked, blocking) - Traffic statistics (bytes sent/received) - Connection timestamp - Client properties (product, version, platform) - Channel count and heartbeat timeout
Requires support user permissions.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
rabbitmq_user_stats_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
username |
string | RabbitMQ username (corresponds to EventSubscription UUID) |
connections |
array of objects | List of active connections with detailed statistics |
connections.source_ip |
string | Client IP address |
connections.vhost |
string | Virtual host name |
connections.connected_at |
string (date-time) | Connection establishment timestamp |
connections.state |
string | Connection state: 'running', 'blocked', 'blocking' |
connections.recv_oct |
integer | Bytes received on this connection |
connections.send_oct |
integer | Bytes sent on this connection |
connections.channels |
integer | Number of channels on this connection |
connections.timeout |
integer | Heartbeat timeout in seconds |
connections.client_properties |
any | Client identification properties |
Rabbitmq Vhost Stats
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/rabbitmq-vhost-stats/ |
List Rabbitmq Vhost Stats |
List Rabbitmq Vhost Stats
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
rabbitmq_vhost_stats_list
1 2 3 4 5 6 7 8 9 10 | |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
name |
string | |
waldur_user |
any | |
subscriptions |
array of objects | |
subscriptions.created |
string (date-time) | |
subscriptions.uuid |
string (uuid) | |
subscriptions.source_ip |
any | An IPv4 or IPv6 address. |
Structure
Customers
A Customer (often referred to as an "Organization") is the top-level entity in the platform that represents a legal body or an independent division. It serves as the primary container for billing, user management, and resource ownership.
All projects, resources, and costs are ultimately tied to a Customer. Users are granted permissions within the scope of a Customer or one of its child Projects.
Key Concepts
- Billing Root: Invoices are generated at the Customer level, aggregating costs from all its projects.
- Ownership: A Customer is owned by one or more users who have full administrative control over its properties, team, and projects.
- Team Management: Users can be added as team members to a Customer with specific roles (e.g., Owner, Manager), granting them permissions across the entire organization.
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/customers/ |
List customers |
| GET | /api/customers/{uuid}/ |
Retrieve customer details |
| POST | /api/customers/ |
Create a new customer |
| PUT | /api/customers/{uuid}/ |
Update a customer |
| PUT | /api/customers/{uuid}/update-project-digest-config/ |
Update project digest configuration |
| PATCH | /api/customers/{uuid}/ |
Partially update a customer |
| PATCH | /api/customers/{uuid}/update-project-digest-config/ |
Update project digest configuration |
| DELETE | /api/customers/{uuid}/ |
Delete a customer |
| User Management | ||
| GET | /api/customers/{uuid}/list_users/ |
List users and their roles in a scope |
| GET | /api/customers/{customer_uuid}/users/ |
List users of a customer |
| POST | /api/customers/{uuid}/add_user/ |
Grant a role to a user |
| POST | /api/customers/{uuid}/delete_user/ |
Revoke a role from a user |
| POST | /api/customers/{uuid}/update_user/ |
Update a user's role expiration |
| Compliance | ||
| GET | /api/customers/{customer_uuid}/project-metadata-compliance-details/ |
Get detailed project metadata compliance |
| GET | /api/customers/{customer_uuid}/project-metadata-compliance-overview/ |
Get project metadata compliance overview |
| GET | /api/customers/{customer_uuid}/project-metadata-compliance-projects/ |
List projects with compliance data |
| GET | /api/customers/{customer_uuid}/project-metadata-question-answers/ |
List questions with project answers |
| Configuration & Updates | ||
| POST | /api/customers/{uuid}/update_organization_groups/ |
Update organization groups for a customer |
| Data & Reporting | ||
| GET | /api/customers/countries/ |
Get list of available countries |
| GET | /api/customers/{uuid}/stats/ |
Get customer resource usage statistics |
| Other Actions | ||
| GET | /api/customers/{uuid}/history/at/ |
Get object state at a specific timestamp |
| GET | /api/customers/{uuid}/history/ |
Get version history |
| GET | /api/customers/{uuid}/project-digest-config/ |
Get project digest configuration |
| POST | /api/customers/{uuid}/contact/ |
Update customer contact details |
| POST | /api/customers/{uuid}/project-digest-config/preview/ |
Preview digest for a project |
| POST | /api/customers/{uuid}/project-digest-config/send-test/ |
Send a test digest email |
Core CRUD
List customers
Retrieve a list of customers. The list is filtered based on the user's permissions.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 | |
- Model Source:
CustomerFieldEnum - API Source:
customers_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
abbreviation |
string | Abbreviation |
accounting_is_running |
boolean | Filter by whether accounting is running. |
agreement_number |
string | |
archived |
boolean | |
backend_id |
string | |
contact_details |
string | Contact details |
current_user_has_project_create_permission |
boolean | Return a list of customers where current user has project create permission. |
field |
array | |
has_resources |
string | Filter by customers with resources. |
is_call_managing_organization |
boolean | Filter by customers that are call managing organizations. |
is_service_provider |
boolean | Filter by customers that are service providers. |
name |
string | Name |
name_exact |
string | Name (exact) |
native_name |
string | Native name |
o |
string | Which field to use when ordering the results. |
organization_group_name |
string | Organization group name |
organization_group_uuid |
array | Organization group UUID |
owned_by_current_user |
boolean | Return a list of customers where current user is owner. |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
query |
string | Filter by name, native name, abbreviation, domain, UUID, registration code or agreement number |
registration_code |
string | |
service_provider_uuid |
string (uuid) | Filter by service provider UUID. |
user_uuid |
string (uuid) | Filter by user UUID. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
organization_groups |
array of objects | Organization groups this customer belongs to |
organization_groups.uuid |
string (uuid) | |
organization_groups.url |
string (uri) | |
organization_groups.name |
string | |
organization_groups.parent_uuid |
string (uuid) | UUID of the parent organization group |
organization_groups.parent_name |
string | Name of the parent organization group |
organization_groups.parent |
string (uri) | |
organization_groups.customers_count |
integer | Number of customers in this organization group |
display_name |
string | Display name of the organization (includes native name if available) |
backend_id |
string | Organization identifier in another application. |
image |
string (uri) | |
blocked |
boolean | |
archived |
boolean | |
display_billing_info_in_projects |
boolean | |
default_tax_percent |
string (decimal) | |
accounting_start_date |
string (date-time) | |
projects_count |
integer | Number of projects in this organization |
users_count |
integer | Number of users with access to this organization |
sponsor_number |
integer | External ID of the sponsor covering the costs |
country_name |
string | Human-readable country name |
max_service_accounts |
integer | Maximum number of service accounts allowed |
project_metadata_checklist |
string (uuid) | Checklist to be used for project metadata validation in this organization |
grace_period_days |
integer | Number of extra days after project end date before resources are terminated |
user_email_patterns |
any | |
user_affiliations |
any | |
user_identity_sources |
any | List of allowed identity sources (identity providers). |
name |
string | |
slug |
string | URL-friendly identifier. Only editable by staff users. |
native_name |
string | |
abbreviation |
string | |
description |
string | |
contact_details |
string | |
agreement_number |
string | |
email |
string (email) | |
phone_number |
string | |
access_subnets |
string | Enter a comma separated list of IPv4 or IPv6 CIDR addresses from where connection to self-service is allowed. |
registration_code |
string | |
homepage |
string (uri) | |
domain |
string | |
vat_code |
string | VAT number |
postal |
string | |
address |
string | |
bank_name |
string | |
latitude |
number (double) | |
longitude |
number (double) | |
bank_account |
string | |
country |
any | Country code (ISO 3166-1 alpha-2) |
notification_emails |
string | Comma-separated list of notification email addresses |
payment_profiles |
array of objects | |
payment_profiles.uuid |
string (uuid) | |
payment_profiles.url |
string (uri) | |
payment_profiles.name |
string | |
payment_profiles.organization_uuid |
string (uuid) | |
payment_profiles.organization |
string (uri) | |
payment_profiles.attributes |
object | |
payment_profiles.attributes.end_date |
string | |
payment_profiles.attributes.agreement_number |
string | |
payment_profiles.attributes.contract_sum |
integer | |
payment_profiles.payment_type |
string | Enum: fixed_price, invoices, payment_gw_monthly |
payment_profiles.payment_type_display |
string | |
payment_profiles.is_active |
boolean | |
customer_credit |
number (double) | |
customer_unallocated_credit |
number (double) | |
is_service_provider |
boolean | |
service_provider |
string (uri) | |
service_provider_uuid |
string (uuid) | |
call_managing_organization_uuid |
string | |
billing_price_estimate |
any |
Retrieve customer details
Fetch the details of a specific customer by its UUID.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
CustomerFieldEnum - API Source:
customers_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
organization_groups |
array of objects | Organization groups this customer belongs to |
organization_groups.uuid |
string (uuid) | |
organization_groups.url |
string (uri) | |
organization_groups.name |
string | |
organization_groups.parent_uuid |
string (uuid) | UUID of the parent organization group |
organization_groups.parent_name |
string | Name of the parent organization group |
organization_groups.parent |
string (uri) | |
organization_groups.customers_count |
integer | Number of customers in this organization group |
display_name |
string | Display name of the organization (includes native name if available) |
backend_id |
string | Organization identifier in another application. |
image |
string (uri) | |
blocked |
boolean | |
archived |
boolean | |
display_billing_info_in_projects |
boolean | |
default_tax_percent |
string (decimal) | |
accounting_start_date |
string (date-time) | |
projects_count |
integer | Number of projects in this organization |
users_count |
integer | Number of users with access to this organization |
sponsor_number |
integer | External ID of the sponsor covering the costs |
country_name |
string | Human-readable country name |
max_service_accounts |
integer | Maximum number of service accounts allowed |
project_metadata_checklist |
string (uuid) | Checklist to be used for project metadata validation in this organization |
grace_period_days |
integer | Number of extra days after project end date before resources are terminated |
user_email_patterns |
any | |
user_affiliations |
any | |
user_identity_sources |
any | List of allowed identity sources (identity providers). |
name |
string | |
slug |
string | URL-friendly identifier. Only editable by staff users. |
native_name |
string | |
abbreviation |
string | |
description |
string | |
contact_details |
string | |
agreement_number |
string | |
email |
string (email) | |
phone_number |
string | |
access_subnets |
string | Enter a comma separated list of IPv4 or IPv6 CIDR addresses from where connection to self-service is allowed. |
registration_code |
string | |
homepage |
string (uri) | |
domain |
string | |
vat_code |
string | VAT number |
postal |
string | |
address |
string | |
bank_name |
string | |
latitude |
number (double) | |
longitude |
number (double) | |
bank_account |
string | |
country |
any | Country code (ISO 3166-1 alpha-2) |
notification_emails |
string | Comma-separated list of notification email addresses |
payment_profiles |
array of objects | |
payment_profiles.uuid |
string (uuid) | |
payment_profiles.url |
string (uri) | |
payment_profiles.name |
string | |
payment_profiles.organization_uuid |
string (uuid) | |
payment_profiles.organization |
string (uri) | |
payment_profiles.attributes |
object | |
payment_profiles.attributes.end_date |
string | |
payment_profiles.attributes.agreement_number |
string | |
payment_profiles.attributes.contract_sum |
integer | |
payment_profiles.payment_type |
string | Enum: fixed_price, invoices, payment_gw_monthly |
payment_profiles.payment_type_display |
string | |
payment_profiles.is_active |
boolean | |
customer_credit |
number (double) | |
customer_unallocated_credit |
number (double) | |
is_service_provider |
boolean | |
service_provider |
string (uri) | |
service_provider_uuid |
string (uuid) | |
call_managing_organization_uuid |
string | |
billing_price_estimate |
any |
Create a new customer
A new customer can only be created by users with staff privilege.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
- Model Source:
CustomerRequest - API Source:
customers_create
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Field | Type | Required | Description |
|---|---|---|---|
backend_id |
string | Organization identifier in another application. | |
image |
string (binary) | ||
blocked |
boolean | ||
archived |
boolean | ||
display_billing_info_in_projects |
boolean | ||
default_tax_percent |
string (decimal) | ||
accounting_start_date |
string (date-time) | ||
sponsor_number |
integer | External ID of the sponsor covering the costs | |
max_service_accounts |
integer | Maximum number of service accounts allowed | |
project_metadata_checklist |
string (uuid) | Checklist to be used for project metadata validation in this organization | |
grace_period_days |
integer | Number of extra days after project end date before resources are terminated | |
user_email_patterns |
any | ||
user_affiliations |
any | ||
user_identity_sources |
any | List of allowed identity sources (identity providers). | |
name |
string | ✓ | |
slug |
string | URL-friendly identifier. Only editable by staff users. | |
native_name |
string | ||
abbreviation |
string | ||
description |
string | ||
contact_details |
string | ||
agreement_number |
string | ||
email |
string (email) | ||
phone_number |
string | ||
access_subnets |
string | Enter a comma separated list of IPv4 or IPv6 CIDR addresses from where connection to self-service is allowed. | |
registration_code |
string | ||
homepage |
string (uri) | ||
domain |
string | ||
vat_code |
string | VAT number | |
postal |
string | ||
address |
string | ||
bank_name |
string | ||
latitude |
number (double) | ||
longitude |
number (double) | ||
bank_account |
string | ||
country |
any | Country code (ISO 3166-1 alpha-2) | |
notification_emails |
string | Comma-separated list of notification email addresses |
201 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
organization_groups |
array of objects | Organization groups this customer belongs to |
organization_groups.uuid |
string (uuid) | |
organization_groups.url |
string (uri) | |
organization_groups.name |
string | |
organization_groups.parent_uuid |
string (uuid) | UUID of the parent organization group |
organization_groups.parent_name |
string | Name of the parent organization group |
organization_groups.parent |
string (uri) | |
organization_groups.customers_count |
integer | Number of customers in this organization group |
display_name |
string | Display name of the organization (includes native name if available) |
backend_id |
string | Organization identifier in another application. |
image |
string (uri) | |
blocked |
boolean | |
archived |
boolean | |
display_billing_info_in_projects |
boolean | |
default_tax_percent |
string (decimal) | |
accounting_start_date |
string (date-time) | |
projects_count |
integer | Number of projects in this organization |
users_count |
integer | Number of users with access to this organization |
sponsor_number |
integer | External ID of the sponsor covering the costs |
country_name |
string | Human-readable country name |
max_service_accounts |
integer | Maximum number of service accounts allowed |
project_metadata_checklist |
string (uuid) | Checklist to be used for project metadata validation in this organization |
grace_period_days |
integer | Number of extra days after project end date before resources are terminated |
user_email_patterns |
any | |
user_affiliations |
any | |
user_identity_sources |
any | List of allowed identity sources (identity providers). |
name |
string | |
slug |
string | URL-friendly identifier. Only editable by staff users. |
native_name |
string | |
abbreviation |
string | |
description |
string | |
contact_details |
string | |
agreement_number |
string | |
email |
string (email) | |
phone_number |
string | |
access_subnets |
string | Enter a comma separated list of IPv4 or IPv6 CIDR addresses from where connection to self-service is allowed. |
registration_code |
string | |
homepage |
string (uri) | |
domain |
string | |
vat_code |
string | VAT number |
postal |
string | |
address |
string | |
bank_name |
string | |
latitude |
number (double) | |
longitude |
number (double) | |
bank_account |
string | |
country |
any | Country code (ISO 3166-1 alpha-2) |
notification_emails |
string | Comma-separated list of notification email addresses |
payment_profiles |
array of objects | |
payment_profiles.uuid |
string (uuid) | |
payment_profiles.url |
string (uri) | |
payment_profiles.name |
string | |
payment_profiles.organization_uuid |
string (uuid) | |
payment_profiles.organization |
string (uri) | |
payment_profiles.attributes |
object | |
payment_profiles.attributes.end_date |
string | |
payment_profiles.attributes.agreement_number |
string | |
payment_profiles.attributes.contract_sum |
integer | |
payment_profiles.payment_type |
string | Enum: fixed_price, invoices, payment_gw_monthly |
payment_profiles.payment_type_display |
string | |
payment_profiles.is_active |
boolean | |
customer_credit |
number (double) | |
customer_unallocated_credit |
number (double) | |
is_service_provider |
boolean | |
service_provider |
string (uri) | |
service_provider_uuid |
string (uuid) | |
call_managing_organization_uuid |
string | |
billing_price_estimate |
any |
Update a customer
Update the details of an existing customer. Requires customer owner or staff permissions.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
CustomerRequest - API Source:
customers_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
backend_id |
string | Organization identifier in another application. | |
image |
string (binary) | ||
blocked |
boolean | ||
archived |
boolean | ||
display_billing_info_in_projects |
boolean | ||
default_tax_percent |
string (decimal) | ||
accounting_start_date |
string (date-time) | ||
sponsor_number |
integer | External ID of the sponsor covering the costs | |
max_service_accounts |
integer | Maximum number of service accounts allowed | |
project_metadata_checklist |
string (uuid) | Checklist to be used for project metadata validation in this organization | |
grace_period_days |
integer | Number of extra days after project end date before resources are terminated | |
user_email_patterns |
any | ||
user_affiliations |
any | ||
user_identity_sources |
any | List of allowed identity sources (identity providers). | |
name |
string | ✓ | |
slug |
string | URL-friendly identifier. Only editable by staff users. | |
native_name |
string | ||
abbreviation |
string | ||
description |
string | ||
contact_details |
string | ||
agreement_number |
string | ||
email |
string (email) | ||
phone_number |
string | ||
access_subnets |
string | Enter a comma separated list of IPv4 or IPv6 CIDR addresses from where connection to self-service is allowed. | |
registration_code |
string | ||
homepage |
string (uri) | ||
domain |
string | ||
vat_code |
string | VAT number | |
postal |
string | ||
address |
string | ||
bank_name |
string | ||
latitude |
number (double) | ||
longitude |
number (double) | ||
bank_account |
string | ||
country |
any | Country code (ISO 3166-1 alpha-2) | |
notification_emails |
string | Comma-separated list of notification email addresses |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
organization_groups |
array of objects | Organization groups this customer belongs to |
organization_groups.uuid |
string (uuid) | |
organization_groups.url |
string (uri) | |
organization_groups.name |
string | |
organization_groups.parent_uuid |
string (uuid) | UUID of the parent organization group |
organization_groups.parent_name |
string | Name of the parent organization group |
organization_groups.parent |
string (uri) | |
organization_groups.customers_count |
integer | Number of customers in this organization group |
display_name |
string | Display name of the organization (includes native name if available) |
backend_id |
string | Organization identifier in another application. |
image |
string (uri) | |
blocked |
boolean | |
archived |
boolean | |
display_billing_info_in_projects |
boolean | |
default_tax_percent |
string (decimal) | |
accounting_start_date |
string (date-time) | |
projects_count |
integer | Number of projects in this organization |
users_count |
integer | Number of users with access to this organization |
sponsor_number |
integer | External ID of the sponsor covering the costs |
country_name |
string | Human-readable country name |
max_service_accounts |
integer | Maximum number of service accounts allowed |
project_metadata_checklist |
string (uuid) | Checklist to be used for project metadata validation in this organization |
grace_period_days |
integer | Number of extra days after project end date before resources are terminated |
user_email_patterns |
any | |
user_affiliations |
any | |
user_identity_sources |
any | List of allowed identity sources (identity providers). |
name |
string | |
slug |
string | URL-friendly identifier. Only editable by staff users. |
native_name |
string | |
abbreviation |
string | |
description |
string | |
contact_details |
string | |
agreement_number |
string | |
email |
string (email) | |
phone_number |
string | |
access_subnets |
string | Enter a comma separated list of IPv4 or IPv6 CIDR addresses from where connection to self-service is allowed. |
registration_code |
string | |
homepage |
string (uri) | |
domain |
string | |
vat_code |
string | VAT number |
postal |
string | |
address |
string | |
bank_name |
string | |
latitude |
number (double) | |
longitude |
number (double) | |
bank_account |
string | |
country |
any | Country code (ISO 3166-1 alpha-2) |
notification_emails |
string | Comma-separated list of notification email addresses |
payment_profiles |
array of objects | |
payment_profiles.uuid |
string (uuid) | |
payment_profiles.url |
string (uri) | |
payment_profiles.name |
string | |
payment_profiles.organization_uuid |
string (uuid) | |
payment_profiles.organization |
string (uri) | |
payment_profiles.attributes |
object | |
payment_profiles.attributes.end_date |
string | |
payment_profiles.attributes.agreement_number |
string | |
payment_profiles.attributes.contract_sum |
integer | |
payment_profiles.payment_type |
string | Enum: fixed_price, invoices, payment_gw_monthly |
payment_profiles.payment_type_display |
string | |
payment_profiles.is_active |
boolean | |
customer_credit |
number (double) | |
customer_unallocated_credit |
number (double) | |
is_service_provider |
boolean | |
service_provider |
string (uri) | |
service_provider_uuid |
string (uuid) | |
call_managing_organization_uuid |
string | |
billing_price_estimate |
any |
Update project digest configuration
Update the project digest email configuration for this organization.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
ProjectDigestConfigRequest - API Source:
customers_update_project_digest_config_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
is_enabled |
boolean | ||
frequency |
string | Enum: weekly, biweekly, monthly |
|
enabled_sections |
array of strings | ||
day_of_week |
integer | For weekly/biweekly: 0=Sunday..6=Saturday | |
day_of_month |
integer | For monthly: day of month (1-28) |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
is_enabled |
boolean | |
frequency |
string | Enum: weekly, biweekly, monthly |
enabled_sections |
array of strings | |
day_of_week |
integer | For weekly/biweekly: 0=Sunday..6=Saturday |
day_of_month |
integer | For monthly: day of month (1-28) |
last_sent_at |
string (date-time) | |
available_sections |
array of objects |
Partially update a customer
Partially update the details of an existing customer. Requires customer owner or staff permissions.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedCustomerRequest - API Source:
customers_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
backend_id |
string | Organization identifier in another application. | |
image |
string (binary) | ||
blocked |
boolean | ||
archived |
boolean | ||
display_billing_info_in_projects |
boolean | ||
default_tax_percent |
string (decimal) | ||
accounting_start_date |
string (date-time) | ||
sponsor_number |
integer | External ID of the sponsor covering the costs | |
max_service_accounts |
integer | Maximum number of service accounts allowed | |
project_metadata_checklist |
string (uuid) | Checklist to be used for project metadata validation in this organization | |
grace_period_days |
integer | Number of extra days after project end date before resources are terminated | |
user_email_patterns |
any | ||
user_affiliations |
any | ||
user_identity_sources |
any | List of allowed identity sources (identity providers). | |
name |
string | ||
slug |
string | URL-friendly identifier. Only editable by staff users. | |
native_name |
string | ||
abbreviation |
string | ||
description |
string | ||
contact_details |
string | ||
agreement_number |
string | ||
email |
string (email) | ||
phone_number |
string | ||
access_subnets |
string | Enter a comma separated list of IPv4 or IPv6 CIDR addresses from where connection to self-service is allowed. | |
registration_code |
string | ||
homepage |
string (uri) | ||
domain |
string | ||
vat_code |
string | VAT number | |
postal |
string | ||
address |
string | ||
bank_name |
string | ||
latitude |
number (double) | ||
longitude |
number (double) | ||
bank_account |
string | ||
country |
any | Country code (ISO 3166-1 alpha-2) | |
notification_emails |
string | Comma-separated list of notification email addresses |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
organization_groups |
array of objects | Organization groups this customer belongs to |
organization_groups.uuid |
string (uuid) | |
organization_groups.url |
string (uri) | |
organization_groups.name |
string | |
organization_groups.parent_uuid |
string (uuid) | UUID of the parent organization group |
organization_groups.parent_name |
string | Name of the parent organization group |
organization_groups.parent |
string (uri) | |
organization_groups.customers_count |
integer | Number of customers in this organization group |
display_name |
string | Display name of the organization (includes native name if available) |
backend_id |
string | Organization identifier in another application. |
image |
string (uri) | |
blocked |
boolean | |
archived |
boolean | |
display_billing_info_in_projects |
boolean | |
default_tax_percent |
string (decimal) | |
accounting_start_date |
string (date-time) | |
projects_count |
integer | Number of projects in this organization |
users_count |
integer | Number of users with access to this organization |
sponsor_number |
integer | External ID of the sponsor covering the costs |
country_name |
string | Human-readable country name |
max_service_accounts |
integer | Maximum number of service accounts allowed |
project_metadata_checklist |
string (uuid) | Checklist to be used for project metadata validation in this organization |
grace_period_days |
integer | Number of extra days after project end date before resources are terminated |
user_email_patterns |
any | |
user_affiliations |
any | |
user_identity_sources |
any | List of allowed identity sources (identity providers). |
name |
string | |
slug |
string | URL-friendly identifier. Only editable by staff users. |
native_name |
string | |
abbreviation |
string | |
description |
string | |
contact_details |
string | |
agreement_number |
string | |
email |
string (email) | |
phone_number |
string | |
access_subnets |
string | Enter a comma separated list of IPv4 or IPv6 CIDR addresses from where connection to self-service is allowed. |
registration_code |
string | |
homepage |
string (uri) | |
domain |
string | |
vat_code |
string | VAT number |
postal |
string | |
address |
string | |
bank_name |
string | |
latitude |
number (double) | |
longitude |
number (double) | |
bank_account |
string | |
country |
any | Country code (ISO 3166-1 alpha-2) |
notification_emails |
string | Comma-separated list of notification email addresses |
payment_profiles |
array of objects | |
payment_profiles.uuid |
string (uuid) | |
payment_profiles.url |
string (uri) | |
payment_profiles.name |
string | |
payment_profiles.organization_uuid |
string (uuid) | |
payment_profiles.organization |
string (uri) | |
payment_profiles.attributes |
object | |
payment_profiles.attributes.end_date |
string | |
payment_profiles.attributes.agreement_number |
string | |
payment_profiles.attributes.contract_sum |
integer | |
payment_profiles.payment_type |
string | Enum: fixed_price, invoices, payment_gw_monthly |
payment_profiles.payment_type_display |
string | |
payment_profiles.is_active |
boolean | |
customer_credit |
number (double) | |
customer_unallocated_credit |
number (double) | |
is_service_provider |
boolean | |
service_provider |
string (uri) | |
service_provider_uuid |
string (uuid) | |
call_managing_organization_uuid |
string | |
billing_price_estimate |
any |
Update project digest configuration
Update the project digest email configuration for this organization.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedProjectDigestConfigRequest - API Source:
customers_update_project_digest_config_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
is_enabled |
boolean | ||
frequency |
string | Enum: weekly, biweekly, monthly |
|
enabled_sections |
array of strings | ||
day_of_week |
integer | For weekly/biweekly: 0=Sunday..6=Saturday | |
day_of_month |
integer | For monthly: day of month (1-28) |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
is_enabled |
boolean | |
frequency |
string | Enum: weekly, biweekly, monthly |
enabled_sections |
array of strings | |
day_of_week |
integer | For weekly/biweekly: 0=Sunday..6=Saturday |
day_of_month |
integer | For monthly: day of month (1-28) |
last_sent_at |
string (date-time) | |
available_sections |
array of objects |
Delete a customer
Delete a customer. This action is only available to staff users. If a customer has any active projects, the deletion request will fail with a 409 Conflict response.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
customers_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
User Management
List users and their roles in a scope
Retrieves a list of users who have a role within a specific scope (e.g., a project or an organization). The list can be filtered by user details or role.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
- Model Source:
UserRoleDetailsFieldEnum - Model Source:
UserRoleDetailsOEnum - API Source:
customers_list_users_list
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
field |
array | Fields to include in response |
full_name |
string | User full name |
native_name |
string | User native name |
o |
array | Ordering fields |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
role |
string (uuid) | Role UUID or name |
search_string |
string | Search string for user |
user |
string (uuid) | User UUID |
user_slug |
string | User slug |
user_url |
string | User URL |
username |
string | User username |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
created |
string (date-time) | |
expiration_time |
string (date-time) | |
role_name |
string | |
role_uuid |
string (uuid) | |
user_email |
string (email) | |
user_full_name |
string | |
user_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
user_uuid |
string (uuid) | |
user_image |
string (uri) | |
created_by_full_name |
string | |
created_by_uuid |
string (uuid) |
List users of a customer
Lists all users who have a role in the specified customer or any of its projects. Requires permissions to list customer users.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
- Model Source:
CustomerUserFieldEnum - Model Source:
CustomerUserOEnum - API Source:
customers_users_list
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required | Description |
|---|---|---|---|
customer_uuid |
string (uuid) | ✓ | UUID of the customer |
| Name | Type | Description |
|---|---|---|
agreement_date |
string (date-time) | Agreement date after |
civil_number |
string | |
date_joined |
string (date-time) | Date joined after |
description |
string | |
email |
string | |
field |
array | |
full_name |
string | Full name |
is_active |
boolean | Is active |
job_title |
string | Job title |
modified |
string (date-time) | Date modified after |
native_name |
string | Native name |
o |
string | Ordering. Sort by a combination of first name, last name, and username. Enum: concatenated_name, -concatenated_name |
organization |
string | Organization |
organization_role |
array | Filter by one or more organization roles. Select a standard role or provide a custom role string. Can be specified multiple times. |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
phone_number |
string | |
project_role |
array | Filter by one or more project roles. Select a standard role or provide a custom role string. Can be specified multiple times. |
registration_method |
string | |
user_keyword |
string | User keyword |
username |
string | Username |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
full_name |
string | |
email |
string (email) | |
role_name |
string | |
projects |
array of objects | |
projects.url |
string (uri) | |
projects.uuid |
string | |
projects.name |
string | |
projects.role_name |
string | |
projects.expiration_time |
string (date-time) | |
expiration_time |
string (date-time) | |
image |
string (uri) |
Grant a role to a user
Assigns a specific role to a user within the current scope. An optional expiration time for the role can be set.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
UserRoleCreateRequest - API Source:
customers_add_user
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
role |
string | ✓ |
user |
string (uuid) | ✓ |
expiration_time |
string (date-time) |
201 -
| Field | Type |
|---|---|
expiration_time |
string (date-time) |
400 - Validation error, for example when trying to add a user to a terminated project.
Revoke a role from a user
Removes a specific role from a user within the current scope. This effectively revokes their permissions associated with that role.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
UserRoleDeleteRequest - API Source:
customers_delete_user
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
role |
string | ✓ |
user |
string (uuid) | ✓ |
expiration_time |
string (date-time) |
200 - Role revoked successfully.
Update a user's role expiration
Updates the expiration time for a user's existing role in the current scope. This is useful for extending or shortening the duration of a permission. To make a role permanent, set expiration_time to null.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
UserRoleUpdateRequest - API Source:
customers_update_user
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
role |
string | ✓ |
user |
string (uuid) | ✓ |
expiration_time |
string (date-time) |
200 -
| Field | Type |
|---|---|
expiration_time |
string (date-time) |
Compliance
Get detailed project metadata compliance
Provides detailed compliance status for all projects within a customer, including individual answers and completion status.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required | Description |
|---|---|---|---|
customer_uuid |
string (uuid) | ✓ | UUID of the customer |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
checklist |
any |
total_projects |
integer |
projects_with_completions |
integer |
fully_completed_projects |
integer |
projects_requiring_review |
integer |
project_details |
array of objects |
project_details.project_uuid |
string (uuid) |
project_details.project_name |
string |
project_details.completion_uuid |
string (uuid) |
project_details.completion_percentage |
number (double) |
project_details.is_completed |
boolean |
project_details.requires_review |
boolean |
project_details.answers |
array of anys |
project_details.unanswered_required_questions |
array of anys |
Get project metadata compliance overview
Provides aggregated statistics about project metadata compliance for all projects within a customer.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required | Description |
|---|---|---|---|
customer_uuid |
string (uuid) | ✓ | UUID of the customer |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
total_projects |
integer |
projects_with_completions |
integer |
fully_completed_projects |
integer |
projects_requiring_review |
integer |
average_completion_percentage |
number (double) |
List projects with compliance data
Provides a paginated list of projects with their checklist completion status and answer details.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required | Description |
|---|---|---|---|
customer_uuid |
string (uuid) | ✓ | UUID of the customer |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
project_uuid |
string (uuid) | |
project_name |
string | |
completion_uuid |
string | Get completion UUID. |
completion_percentage |
number (double) | Get completion percentage. |
is_completed |
boolean | Get completion status. |
requires_review |
boolean | Get review requirement status. |
answers_count |
integer | Get count of answers. |
unanswered_required_count |
integer | Get count of unanswered required questions. |
List questions with project answers
Provides a paginated list of all questions from the customer's compliance checklist, including the answers given in each project.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- API Source:
customers_project_metadata_question_answers_list
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required | Description |
|---|---|---|---|
customer_uuid |
string (uuid) | ✓ | UUID of the customer |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
question_uuid |
string (uuid) | |
question_description |
string | |
question_type |
string | |
required |
boolean | |
order |
integer | |
min_value |
string (decimal) | |
max_value |
string (decimal) | |
total_projects |
integer | Get total projects count. |
answered_projects_count |
integer | Get count of projects that answered this question. |
project_answers |
array of objects | Get all project answers for this question. |
question_options |
array of objects | Get question options for select-type questions. |
Configuration & Updates
Update organization groups for a customer
Assigns a customer to one or more organization groups. This action is restricted to staff users.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
OrganizationGroupsRequest - API Source:
customers_update_organization_groups
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
organization_groups |
array of string (uri)s |
200 - No response body
Data & Reporting
Get list of available countries
Returns a list of countries that can be used when creating or updating a customer. The list can be configured by the service provider.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
customers_countries_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
abbreviation |
string | Abbreviation |
accounting_is_running |
boolean | Filter by whether accounting is running. |
agreement_number |
string | |
archived |
boolean | |
backend_id |
string | |
contact_details |
string | Contact details |
current_user_has_project_create_permission |
boolean | Return a list of customers where current user has project create permission. |
has_resources |
string | Filter by customers with resources. |
is_call_managing_organization |
boolean | Filter by customers that are call managing organizations. |
is_service_provider |
boolean | Filter by customers that are service providers. |
name |
string | Name |
name_exact |
string | Name (exact) |
native_name |
string | Native name |
o |
string | Which field to use when ordering the results. |
organization_group_name |
string | Organization group name |
organization_group_uuid |
array | Organization group UUID |
owned_by_current_user |
boolean | Return a list of customers where current user is owner. |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
query |
string | Filter by name, native name, abbreviation, domain, UUID, registration code or agreement number |
registration_code |
string | |
service_provider_uuid |
string (uuid) | Filter by service provider UUID. |
user_uuid |
string (uuid) | Filter by user UUID. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
label |
string |
value |
string |
Get customer resource usage statistics
Provides statistics about the resource usage (e.g., CPU, RAM, storage) for all projects within a customer. Can be filtered to show usage for the current month only.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
customers_stats_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
for_current_month |
boolean | If true, returns usage data for the current month only. Otherwise, returns total usage. |
200 -
| Field | Type |
|---|---|
components |
array of objects |
components.type |
string |
components.name |
string |
components.description |
string |
components.measured_unit |
string |
components.billing_type |
string |
components.usage |
integer |
components.limit_usage |
integer |
components.limit |
integer |
components.offering_name |
string |
components.offering_uuid |
string (uuid) |
Other Actions
Get object state at a specific timestamp
Returns the state of the object as it was at the specified timestamp. Only accessible by staff and support users.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- API Source:
customers_history_at_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Required | Description |
|---|---|---|---|
timestamp |
string | ✓ | ISO 8601 timestamp to query the object state at |
200 -
| Field | Type | Description |
|---|---|---|
id |
integer | Version ID |
revision_date |
string (date-time) | When this revision was created |
revision_user |
object (free-form) | User who created this revision |
revision_comment |
string | Comment describing the revision |
serialized_data |
object (free-form) | Serialized model fields at this revision |
400 -
404 -
Get version history
Returns the version history for this object. Only accessible by staff and support users.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- API Source:
customers_history_list
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
abbreviation |
string | Abbreviation |
accounting_is_running |
boolean | Filter by whether accounting is running. |
agreement_number |
string | |
archived |
boolean | |
backend_id |
string | |
contact_details |
string | Contact details |
created_after |
string | Filter versions created after this timestamp (ISO 8601) |
created_before |
string | Filter versions created before this timestamp (ISO 8601) |
current_user_has_project_create_permission |
boolean | Return a list of customers where current user has project create permission. |
has_resources |
string | Filter by customers with resources. |
is_call_managing_organization |
boolean | Filter by customers that are call managing organizations. |
is_service_provider |
boolean | Filter by customers that are service providers. |
name |
string | Name |
name_exact |
string | Name (exact) |
native_name |
string | Native name |
o |
string | Which field to use when ordering the results. |
organization_group_name |
string | Organization group name |
organization_group_uuid |
array | Organization group UUID |
owned_by_current_user |
boolean | Return a list of customers where current user is owner. |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
query |
string | Filter by name, native name, abbreviation, domain, UUID, registration code or agreement number |
registration_code |
string | |
service_provider_uuid |
string (uuid) | Filter by service provider UUID. |
user_uuid |
string (uuid) | Filter by user UUID. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
id |
integer | Version ID |
revision_date |
string (date-time) | When this revision was created |
revision_user |
object (free-form) | User who created this revision |
revision_comment |
string | Comment describing the revision |
serialized_data |
object (free-form) | Serialized model fields at this revision |
Get project digest configuration
Retrieve the project digest email configuration for this organization.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
customers_project_digest_config_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
is_enabled |
boolean | |
frequency |
string | Enum: weekly, biweekly, monthly |
enabled_sections |
array of strings | |
day_of_week |
integer | For weekly/biweekly: 0=Sunday..6=Saturday |
day_of_month |
integer | For monthly: day of month (1-28) |
last_sent_at |
string (date-time) | |
available_sections |
array of objects |
Update customer contact details
Update organization contact information. Requires CUSTOMER_CONTACT_UPDATE or CUSTOMER.UPDATE permission.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
CustomerContactUpdateRequest - API Source:
customers_contact
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
contact_details |
string | ||
email |
string (email) | ||
phone_number |
string | ||
homepage |
string (uri) | ||
notification_emails |
string | Comma-separated list of notification email addresses |
200 -
| Field | Type | Description |
|---|---|---|
contact_details |
string | |
email |
string (email) | |
phone_number |
string | |
homepage |
string (uri) | |
notification_emails |
string | Comma-separated list of notification email addresses |
Preview digest for a project
Returns rendered HTML preview of the digest for a specific project.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
ProjectDigestPreviewRequest - API Source:
customers_project_digest_config_preview
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
project_uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
subject |
string |
html_body |
string |
text_body |
string |
Send a test digest email
Send a test digest email to the requesting user.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
customers_project_digest_config_send_test
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - No response body
Organization Groups
An Organization group is a high-level classification used to group multiple Customers (Organizations) together. It provides an additional layer of administrative structure above the Customer level, allowing for a tree-like, hierarchical organization of customers into groups and sub-groups.
In practice, Organization Groups are a powerful tool for managing access control, applying policies, and generating aggregated reports across specific cohorts of customers.
Key Functions
- Control Offering and Plan Visibility:
- Offerings can be associated with one or more Organization Groups, making them exclusively available for ordering by Customers within those groups.
-
Similarly, pricing Plans can be restricted to specific Organization Groups. This allows service providers to create custom pricing tiers for different customer segments (e.g., educational institutions, commercial partners).
-
Apply Policies at Scale:
-
Policies, such as usage limits, can be targeted at an entire Organization Group. This allows for setting and enforcing aggregate consumption limits across all customers belonging to a group, rather than managing them individually.
-
Enable Aggregated Reporting and Analytics:
- The API uses Organization Groups as a key dimension for statistical reporting. You can retrieve aggregated data, such as:
- Active resource counts
- Component usage metrics
- User and project counts for service providers
-
This provides a high-level overview of usage and activity segmented by customer groups.
-
Manage Service Provider Data Visibility:
- Permissions for service providers can be influenced by Organization Groups. For instance, a provider might gain visibility into user data or other resources related to offerings that are available to the organization groups their customers belong to.
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/organization-groups/ |
List Organization Groups |
| GET | /api/organization-groups/{uuid}/ |
Retrieve |
| POST | /api/organization-groups/ |
Create |
| PUT | /api/organization-groups/{uuid}/ |
Update |
| PATCH | /api/organization-groups/{uuid}/ |
Partial Update |
| DELETE | /api/organization-groups/{uuid}/ |
Delete |
List Organization Groups
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
organization_groups_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
name |
string | Name |
name_exact |
string | Name (exact) |
o |
string | Which field to use when ordering the results. |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
parent |
string (uuid) | Parent UUID |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
name |
string | |
parent_uuid |
string (uuid) | UUID of the parent organization group |
parent_name |
string | Name of the parent organization group |
parent |
string (uri) | |
customers_count |
integer | Number of customers in this organization group |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
organization_groups_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
name |
string | |
parent_uuid |
string (uuid) | UUID of the parent organization group |
parent_name |
string | Name of the parent organization group |
parent |
string (uri) | |
customers_count |
integer | Number of customers in this organization group |
Create
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
- Model Source:
OrganizationGroupRequest - API Source:
organization_groups_create
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Field | Type | Required |
|---|---|---|
name |
string | ✓ |
parent |
string (uri) |
201 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
name |
string | |
parent_uuid |
string (uuid) | UUID of the parent organization group |
parent_name |
string | Name of the parent organization group |
parent |
string (uri) | |
customers_count |
integer | Number of customers in this organization group |
Update
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
OrganizationGroupRequest - API Source:
organization_groups_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
name |
string | ✓ |
parent |
string (uri) |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
name |
string | |
parent_uuid |
string (uuid) | UUID of the parent organization group |
parent_name |
string | Name of the parent organization group |
parent |
string (uri) | |
customers_count |
integer | Number of customers in this organization group |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedOrganizationGroupRequest - API Source:
organization_groups_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
name |
string | |
parent |
string (uri) |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
name |
string | |
parent_uuid |
string (uuid) | UUID of the parent organization group |
parent_name |
string | Name of the parent organization group |
parent |
string (uri) | |
customers_count |
integer | Number of customers in this organization group |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
organization_groups_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Project Types
Simple model for categorizing projects. Provides project type classification with name, description, and UUID identification. Used to categorize projects into different types for organizational purposes.
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/project-types/ |
List project types |
| GET | /api/project-types/{uuid}/ |
Retrieve project type details |
List project types
Retrieve a list of available project types.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
project_types_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
name |
string | Name |
name_exact |
string | Name (exact) |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
uuid |
string (uuid) |
url |
string (uri) |
name |
string |
description |
string |
Retrieve project type details
Fetch details of a specific project type by its UUID.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
project_types_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
url |
string (uri) |
name |
string |
description |
string |
Projects
A Project is a workspace within a Customer used to organize cloud resources, manage team access, and track costs for a specific initiative or department. Every resource, such as a virtual machine or a database, must belong to a Project.
This entity acts as a scope for collaboration, allowing a subset of users from the parent Customer to work together with specific permissions.
Key Concepts
- Hierarchical Structure: Every Project must belong to exactly one Customer. It cannot exist independently.
- Resource Container: Projects are the direct parents of all provisioned resources in the cloud.
- Team Collaboration: A Project has its own team of members with roles (e.g., Project Manager, Administrator) that are scoped only to that project.
- Cost Tracking: While billing is handled by the parent Customer, costs are tracked on a per-project basis, enabling fine-grained financial reporting.
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/projects/ |
List projects |
| GET | /api/projects/{uuid}/ |
Retrieve project details |
| POST | /api/projects/ |
Create a new project |
| PUT | /api/projects/{uuid}/ |
Update project details |
| PATCH | /api/projects/{uuid}/ |
Partially update project details |
| DELETE | /api/projects/{uuid}/ |
Delete a project |
| State Management | ||
| POST | /api/projects/{uuid}/recover/ |
Recover a soft-deleted project |
| User Management | ||
| GET | /api/projects/{uuid}/list_users/ |
List users and their roles in a scope |
| GET | /api/projects/{project_uuid}/other_users/ |
Other users |
| POST | /api/projects/{uuid}/add_user/ |
Grant a role to a user |
| POST | /api/projects/{uuid}/delete_user/ |
Revoke a role from a user |
| POST | /api/projects/{uuid}/update_user/ |
Update a user's role expiration |
| Configuration & Updates | ||
| POST | /api/projects/{uuid}/move_project/ |
Move project to another customer |
| Data & Reporting | ||
| GET | /api/projects/{uuid}/stats/ |
Get project resource usage statistics |
| Checklists | ||
| GET | /api/projects/{uuid}/checklist/ |
Get checklist with questions and existing answers |
| GET | /api/projects/checklist-template/ |
Get checklist template for creating new objects |
| GET | /api/projects/{uuid}/completion_status/ |
Get checklist completion status |
| POST | /api/projects/{uuid}/submit_answers/ |
Submit checklist answers |
| Remote Actions & Sync | ||
| POST | /api/projects/{uuid}/sync_user_roles/ |
Sync user roles |
Core CRUD
List projects
Retrieve a list of projects. The list is filtered based on the user's permissions. By default, only active projects are shown.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- Model Source:
MarketplaceProviderCustomerProjectOEnum - Model Source:
ProjectFieldEnum - API Source:
projects_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
accounting_is_running |
boolean | Filter by whether accounting is running. |
backend_id |
string | |
can_admin |
boolean | Return a list of projects where current user is admin. |
can_manage |
boolean | Return a list of projects where current user is manager or a customer owner. |
conceal_finished_projects |
boolean | Conceal finished projects |
created |
string (date-time) | Created after |
customer |
array | Multiple values may be separated by commas. |
customer_abbreviation |
string | Customer abbreviation |
customer_name |
string | Customer name |
customer_native_name |
string | Customer native name |
description |
string | Description |
field |
array | |
include_terminated |
boolean | Include soft-deleted (terminated) projects. Only available to staff and support users, or users with organizational roles who can see their terminated projects. |
is_removed |
boolean | Is removed |
modified |
string (date-time) | Modified after |
name |
string | Name |
name_exact |
string | Name (exact) |
o |
array | Ordering |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
query |
string | Filter by name, slug, UUID, backend ID or resource effective ID |
slug |
string | Slug |
user_uuid |
string (uuid) | Filter by user UUID. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
slug |
string | URL-friendly identifier. Only editable by staff users. |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_slug |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
description |
string | Project description (HTML content will be sanitized) |
customer_display_billing_info_in_projects |
boolean | |
created |
string (date-time) | |
type |
string (uri) | |
type_name |
string | |
type_uuid |
string (uuid) | |
backend_id |
string | |
start_date |
string (date) | Project start date. Cannot be edited after the start date has arrived. |
end_date |
string (date) | Project end date. Setting this field requires DELETE_PROJECT permission. |
end_date_requested_by |
string (uri) | |
oecd_fos_2007_code |
any | |
oecd_fos_2007_label |
string | Human-readable label for the OECD FOS 2007 classification code |
is_industry |
boolean | |
image |
string (uri) | |
resources_count |
integer | Number of active resources in this project |
max_service_accounts |
integer | Maximum number of service accounts allowed |
kind |
any | |
is_removed |
boolean | |
termination_metadata |
any | Metadata about project termination (read-only) |
staff_notes |
string | Internal notes visible only to staff and support users (HTML content will be sanitized) |
grace_period_days |
integer | Number of extra days after project end date before resources are terminated. Overrides customer-level setting. |
user_email_patterns |
any | |
user_affiliations |
any | |
user_identity_sources |
any | List of allowed identity sources (identity providers). |
project_credit |
number (double) | |
marketplace_resource_count |
object (free-form) | |
billing_price_estimate |
any |
Retrieve project details
Fetch the details of a specific project by its UUID. Users can access details of terminated projects they previously had access to.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
ProjectFieldEnum - API Source:
projects_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
slug |
string | URL-friendly identifier. Only editable by staff users. |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_slug |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
description |
string | Project description (HTML content will be sanitized) |
customer_display_billing_info_in_projects |
boolean | |
created |
string (date-time) | |
type |
string (uri) | |
type_name |
string | |
type_uuid |
string (uuid) | |
backend_id |
string | |
start_date |
string (date) | Project start date. Cannot be edited after the start date has arrived. |
end_date |
string (date) | Project end date. Setting this field requires DELETE_PROJECT permission. |
end_date_requested_by |
string (uri) | |
oecd_fos_2007_code |
any | |
oecd_fos_2007_label |
string | Human-readable label for the OECD FOS 2007 classification code |
is_industry |
boolean | |
image |
string (uri) | |
resources_count |
integer | Number of active resources in this project |
max_service_accounts |
integer | Maximum number of service accounts allowed |
kind |
any | |
is_removed |
boolean | |
termination_metadata |
any | Metadata about project termination (read-only) |
staff_notes |
string | Internal notes visible only to staff and support users (HTML content will be sanitized) |
grace_period_days |
integer | Number of extra days after project end date before resources are terminated. Overrides customer-level setting. |
user_email_patterns |
any | |
user_affiliations |
any | |
user_identity_sources |
any | List of allowed identity sources (identity providers). |
project_credit |
number (double) | |
marketplace_resource_count |
object (free-form) | |
billing_price_estimate |
any |
Create a new project
A new project can be created by users with staff privilege (is_staff=True) or customer owners. Project resource quota is optional.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
ProjectRequest - API Source:
projects_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ✓ | |
slug |
string | URL-friendly identifier. Only editable by staff users. | |
customer |
string (uri) | ✓ | |
description |
string | Project description (HTML content will be sanitized) | |
type |
string (uri) | ||
backend_id |
string | ||
start_date |
string (date) | Project start date. Cannot be edited after the start date has arrived. | |
end_date |
string (date) | Project end date. Setting this field requires DELETE_PROJECT permission. | |
oecd_fos_2007_code |
any | ||
is_industry |
boolean | ||
image |
string (binary) | ||
kind |
any | ||
staff_notes |
string | Internal notes visible only to staff and support users (HTML content will be sanitized) | |
grace_period_days |
integer | Number of extra days after project end date before resources are terminated. Overrides customer-level setting. | |
user_email_patterns |
any | ||
user_affiliations |
any | ||
user_identity_sources |
any | List of allowed identity sources (identity providers). |
201 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
slug |
string | URL-friendly identifier. Only editable by staff users. |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_slug |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
description |
string | Project description (HTML content will be sanitized) |
customer_display_billing_info_in_projects |
boolean | |
created |
string (date-time) | |
type |
string (uri) | |
type_name |
string | |
type_uuid |
string (uuid) | |
backend_id |
string | |
start_date |
string (date) | Project start date. Cannot be edited after the start date has arrived. |
end_date |
string (date) | Project end date. Setting this field requires DELETE_PROJECT permission. |
end_date_requested_by |
string (uri) | |
oecd_fos_2007_code |
any | |
oecd_fos_2007_label |
string | Human-readable label for the OECD FOS 2007 classification code |
is_industry |
boolean | |
image |
string (uri) | |
resources_count |
integer | Number of active resources in this project |
max_service_accounts |
integer | Maximum number of service accounts allowed |
kind |
any | |
is_removed |
boolean | |
termination_metadata |
any | Metadata about project termination (read-only) |
staff_notes |
string | Internal notes visible only to staff and support users (HTML content will be sanitized) |
grace_period_days |
integer | Number of extra days after project end date before resources are terminated. Overrides customer-level setting. |
user_email_patterns |
any | |
user_affiliations |
any | |
user_identity_sources |
any | List of allowed identity sources (identity providers). |
project_credit |
number (double) | |
marketplace_resource_count |
object (free-form) | |
billing_price_estimate |
any |
Update project details
Update the details of a project. Requires project administrator or customer owner permissions.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
ProjectRequest - API Source:
projects_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ✓ | |
slug |
string | URL-friendly identifier. Only editable by staff users. | |
customer |
string (uri) | ✓ | |
description |
string | Project description (HTML content will be sanitized) | |
type |
string (uri) | ||
backend_id |
string | ||
start_date |
string (date) | Project start date. Cannot be edited after the start date has arrived. | |
end_date |
string (date) | Project end date. Setting this field requires DELETE_PROJECT permission. | |
oecd_fos_2007_code |
any | ||
is_industry |
boolean | ||
image |
string (binary) | ||
kind |
any | ||
staff_notes |
string | Internal notes visible only to staff and support users (HTML content will be sanitized) | |
grace_period_days |
integer | Number of extra days after project end date before resources are terminated. Overrides customer-level setting. | |
user_email_patterns |
any | ||
user_affiliations |
any | ||
user_identity_sources |
any | List of allowed identity sources (identity providers). |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
slug |
string | URL-friendly identifier. Only editable by staff users. |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_slug |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
description |
string | Project description (HTML content will be sanitized) |
customer_display_billing_info_in_projects |
boolean | |
created |
string (date-time) | |
type |
string (uri) | |
type_name |
string | |
type_uuid |
string (uuid) | |
backend_id |
string | |
start_date |
string (date) | Project start date. Cannot be edited after the start date has arrived. |
end_date |
string (date) | Project end date. Setting this field requires DELETE_PROJECT permission. |
end_date_requested_by |
string (uri) | |
oecd_fos_2007_code |
any | |
oecd_fos_2007_label |
string | Human-readable label for the OECD FOS 2007 classification code |
is_industry |
boolean | |
image |
string (uri) | |
resources_count |
integer | Number of active resources in this project |
max_service_accounts |
integer | Maximum number of service accounts allowed |
kind |
any | |
is_removed |
boolean | |
termination_metadata |
any | Metadata about project termination (read-only) |
staff_notes |
string | Internal notes visible only to staff and support users (HTML content will be sanitized) |
grace_period_days |
integer | Number of extra days after project end date before resources are terminated. Overrides customer-level setting. |
user_email_patterns |
any | |
user_affiliations |
any | |
user_identity_sources |
any | List of allowed identity sources (identity providers). |
project_credit |
number (double) | |
marketplace_resource_count |
object (free-form) | |
billing_price_estimate |
any |
Partially update project details
Partially update the details of a project. Requires project administrator or customer owner permissions.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedProjectRequest - API Source:
projects_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ||
slug |
string | URL-friendly identifier. Only editable by staff users. | |
customer |
string (uri) | ||
description |
string | Project description (HTML content will be sanitized) | |
type |
string (uri) | ||
backend_id |
string | ||
start_date |
string (date) | Project start date. Cannot be edited after the start date has arrived. | |
end_date |
string (date) | Project end date. Setting this field requires DELETE_PROJECT permission. | |
oecd_fos_2007_code |
any | ||
is_industry |
boolean | ||
image |
string (binary) | ||
kind |
any | ||
staff_notes |
string | Internal notes visible only to staff and support users (HTML content will be sanitized) | |
grace_period_days |
integer | Number of extra days after project end date before resources are terminated. Overrides customer-level setting. | |
user_email_patterns |
any | ||
user_affiliations |
any | ||
user_identity_sources |
any | List of allowed identity sources (identity providers). |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
slug |
string | URL-friendly identifier. Only editable by staff users. |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_slug |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
description |
string | Project description (HTML content will be sanitized) |
customer_display_billing_info_in_projects |
boolean | |
created |
string (date-time) | |
type |
string (uri) | |
type_name |
string | |
type_uuid |
string (uuid) | |
backend_id |
string | |
start_date |
string (date) | Project start date. Cannot be edited after the start date has arrived. |
end_date |
string (date) | Project end date. Setting this field requires DELETE_PROJECT permission. |
end_date_requested_by |
string (uri) | |
oecd_fos_2007_code |
any | |
oecd_fos_2007_label |
string | Human-readable label for the OECD FOS 2007 classification code |
is_industry |
boolean | |
image |
string (uri) | |
resources_count |
integer | Number of active resources in this project |
max_service_accounts |
integer | Maximum number of service accounts allowed |
kind |
any | |
is_removed |
boolean | |
termination_metadata |
any | Metadata about project termination (read-only) |
staff_notes |
string | Internal notes visible only to staff and support users (HTML content will be sanitized) |
grace_period_days |
integer | Number of extra days after project end date before resources are terminated. Overrides customer-level setting. |
user_email_patterns |
any | |
user_affiliations |
any | |
user_identity_sources |
any | List of allowed identity sources (identity providers). |
project_credit |
number (double) | |
marketplace_resource_count |
object (free-form) | |
billing_price_estimate |
any |
Delete a project
Delete a project. If the project has any active resources, the deletion request will fail with a 409 Conflict response. This action performs a soft-delete, and the project can be recovered later.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
projects_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
State Management
Recover a soft-deleted project
Recovers a soft-deleted (terminated) project, making it active again. Provides options to restore previous team members automatically (staff-only) or send them new invitations.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
ProjectRecoveryRequest - API Source:
projects_recover
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
restore_team_members |
boolean | Whether to automatically restore team members who had access before project deletion (staff only) Constraints: default: False |
|
send_invitations_to_previous_members |
boolean | Whether to send invitations to users who had access before project deletion Constraints: default: False |
|
end_date |
string (date) | End date for the recovered project |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
slug |
string | URL-friendly identifier. Only editable by staff users. |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_slug |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
description |
string | Project description (HTML content will be sanitized) |
customer_display_billing_info_in_projects |
boolean | |
created |
string (date-time) | |
type |
string (uri) | |
type_name |
string | |
type_uuid |
string (uuid) | |
backend_id |
string | |
start_date |
string (date) | Project start date. Cannot be edited after the start date has arrived. |
end_date |
string (date) | Project end date. Setting this field requires DELETE_PROJECT permission. |
end_date_requested_by |
string (uri) | |
oecd_fos_2007_code |
any | |
oecd_fos_2007_label |
string | Human-readable label for the OECD FOS 2007 classification code |
is_industry |
boolean | |
image |
string (uri) | |
resources_count |
integer | Number of active resources in this project |
max_service_accounts |
integer | Maximum number of service accounts allowed |
kind |
any | |
is_removed |
boolean | |
termination_metadata |
any | Metadata about project termination (read-only) |
staff_notes |
string | Internal notes visible only to staff and support users (HTML content will be sanitized) |
grace_period_days |
integer | Number of extra days after project end date before resources are terminated. Overrides customer-level setting. |
user_email_patterns |
any | |
user_affiliations |
any | |
user_identity_sources |
any | List of allowed identity sources (identity providers). |
project_credit |
number (double) | |
marketplace_resource_count |
object (free-form) | |
billing_price_estimate |
any |
User Management
List users and their roles in a scope
Retrieves a list of users who have a role within a specific scope (e.g., a project or an organization). The list can be filtered by user details or role.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
- Model Source:
UserRoleDetailsFieldEnum - Model Source:
UserRoleDetailsOEnum - API Source:
projects_list_users_list
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
field |
array | Fields to include in response |
full_name |
string | User full name |
native_name |
string | User native name |
o |
array | Ordering fields |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
role |
string (uuid) | Role UUID or name |
search_string |
string | Search string for user |
user |
string (uuid) | User UUID |
user_slug |
string | User slug |
user_url |
string | User URL |
username |
string | User username |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
created |
string (date-time) | |
expiration_time |
string (date-time) | |
role_name |
string | |
role_uuid |
string (uuid) | |
user_email |
string (email) | |
user_full_name |
string | |
user_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
user_uuid |
string (uuid) | |
user_image |
string (uri) | |
created_by_full_name |
string | |
created_by_uuid |
string (uuid) |
Other users
A list of users which can be added to the current project from other projects of the same customer.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
- Model Source:
CustomerUserOEnum - API Source:
projects_other_users_list
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required | Description |
|---|---|---|---|
project_uuid |
string (uuid) | ✓ | UUID of the project |
| Name | Type | Description |
|---|---|---|
agreement_date |
string (date-time) | Agreement date after |
civil_number |
string | |
date_joined |
string (date-time) | Date joined after |
description |
string | |
email |
string | |
full_name |
string | Full name |
is_active |
boolean | Is active |
job_title |
string | Job title |
modified |
string (date-time) | Date modified after |
native_name |
string | Native name |
o |
string | Ordering. Sort by a combination of first name, last name, and username. Enum: concatenated_name, -concatenated_name |
organization |
string | Organization |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
phone_number |
string | |
registration_method |
string | |
user_keyword |
string | User keyword |
username |
string | Username |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
full_name |
string | |
native_name |
string | |
email |
string (email) | |
image |
string (uri) |
Grant a role to a user
Assigns a specific role to a user within the current scope. An optional expiration time for the role can be set.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
UserRoleCreateRequest - API Source:
projects_add_user
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
role |
string | ✓ |
user |
string (uuid) | ✓ |
expiration_time |
string (date-time) |
201 -
| Field | Type |
|---|---|
expiration_time |
string (date-time) |
400 - Validation error, for example when trying to add a user to a terminated project.
Revoke a role from a user
Removes a specific role from a user within the current scope. This effectively revokes their permissions associated with that role.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
UserRoleDeleteRequest - API Source:
projects_delete_user
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
role |
string | ✓ |
user |
string (uuid) | ✓ |
expiration_time |
string (date-time) |
200 - Role revoked successfully.
Update a user's role expiration
Updates the expiration time for a user's existing role in the current scope. This is useful for extending or shortening the duration of a permission. To make a role permanent, set expiration_time to null.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
UserRoleUpdateRequest - API Source:
projects_update_user
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
role |
string | ✓ |
user |
string (uuid) | ✓ |
expiration_time |
string (date-time) |
200 -
| Field | Type |
|---|---|
expiration_time |
string (date-time) |
Configuration & Updates
Move project to another customer
Moves a project and its associated resources to a different customer. You can choose whether to preserve existing project permissions for users. Terminated projects can also be moved.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
MoveProjectRequest - API Source:
projects_move_project
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
customer |
string (uri) | ✓ |
preserve_permissions |
boolean | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
slug |
string | URL-friendly identifier. Only editable by staff users. |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_slug |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
description |
string | Project description (HTML content will be sanitized) |
customer_display_billing_info_in_projects |
boolean | |
created |
string (date-time) | |
type |
string (uri) | |
type_name |
string | |
type_uuid |
string (uuid) | |
backend_id |
string | |
start_date |
string (date) | Project start date. Cannot be edited after the start date has arrived. |
end_date |
string (date) | Project end date. Setting this field requires DELETE_PROJECT permission. |
end_date_requested_by |
string (uri) | |
oecd_fos_2007_code |
any | |
oecd_fos_2007_label |
string | Human-readable label for the OECD FOS 2007 classification code |
is_industry |
boolean | |
image |
string (uri) | |
resources_count |
integer | Number of active resources in this project |
max_service_accounts |
integer | Maximum number of service accounts allowed |
kind |
any | |
is_removed |
boolean | |
termination_metadata |
any | Metadata about project termination (read-only) |
staff_notes |
string | Internal notes visible only to staff and support users (HTML content will be sanitized) |
grace_period_days |
integer | Number of extra days after project end date before resources are terminated. Overrides customer-level setting. |
user_email_patterns |
any | |
user_affiliations |
any | |
user_identity_sources |
any | List of allowed identity sources (identity providers). |
project_credit |
number (double) | |
marketplace_resource_count |
object (free-form) | |
billing_price_estimate |
any |
Data & Reporting
Get project resource usage statistics
Provides statistics about the resource usage (e.g., CPU, RAM, storage) for all resources within a project. Can be filtered to show usage for the current month only.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
projects_stats_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
for_current_month |
boolean | If true, returns usage data for the current month only. Otherwise, returns total usage. |
200 -
| Field | Type |
|---|---|
components |
array of objects |
components.type |
string |
components.name |
string |
components.description |
string |
components.measured_unit |
string |
components.billing_type |
string |
components.usage |
integer |
components.limit_usage |
integer |
components.limit |
integer |
components.offering_name |
string |
components.offering_uuid |
string (uuid) |
Checklists
Get checklist with questions and existing answers
Get checklist with questions and existing answers.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
projects_checklist_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
include_all |
boolean | If true, returns all questions including hidden ones (for dynamic form visibility). Default: false. |
200 -
| Field | Type | Description |
|---|---|---|
checklist |
object (free-form) | |
completion |
object | |
completion.uuid |
string (uuid) | |
completion.is_completed |
boolean | Whether all required questions have been answered |
completion.completion_percentage |
number (double) | |
completion.unanswered_required_questions |
array of anys | |
completion.checklist_name |
string | |
completion.checklist_description |
string | |
completion.created |
string (date-time) | |
completion.modified |
string (date-time) | |
questions |
array of objects | |
questions.uuid |
string (uuid) | |
questions.description |
string | |
questions.user_guidance |
string | |
questions.question_type |
any | Type of question and expected answer format |
questions.required |
boolean | |
questions.order |
integer | |
questions.existing_answer |
object (free-form) | |
questions.question_options |
array of anys | |
questions.min_value |
string (decimal) | Minimum value allowed for NUMBER, YEAR, and RATING type questions |
questions.max_value |
string (decimal) | Maximum value allowed for NUMBER, YEAR, and RATING type questions |
questions.allowed_file_types |
any | List of allowed file extensions (e.g., ['.pdf', '.doc', '.docx']). If empty, all file types are allowed. |
questions.allowed_mime_types |
any | List of allowed MIME types (e.g., ['application/pdf', 'application/msword']). If empty, MIME type validation is not enforced. When both extensions and MIME types are specified, files must match both criteria for security. |
questions.max_file_size_mb |
integer | Maximum file size in megabytes. If not set, no size limit is enforced. |
questions.max_files_count |
integer | Maximum number of files allowed for MULTIPLE_FILES type questions. If not set, no count limit is enforced. |
questions.dependencies_info |
object (free-form) |
400 -
404 -
Get checklist template for creating new objects
Get checklist template for creating new objects.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
projects_checklist_template_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required | Description |
|---|---|---|---|
parent_uuid |
string (uuid) | ✓ | UUID of the parent object (e.g., customer UUID for new projects) |
200 -
| Field | Type | Description |
|---|---|---|
checklist |
object (free-form) | |
questions |
array of objects | |
questions.uuid |
string (uuid) | |
questions.required |
boolean | |
questions.description |
string | |
questions.user_guidance |
string | Additional guidance text visible to users when answering and reviewing |
questions.question_options |
array of objects | |
questions.question_options.uuid |
string (uuid) | |
questions.question_options.label |
string | |
questions.question_options.order |
integer | |
questions.question_type |
any | Type of question and expected answer format |
questions.order |
integer | |
questions.min_value |
string (decimal) | Minimum value allowed for NUMBER, YEAR, and RATING type questions |
questions.max_value |
string (decimal) | Maximum value allowed for NUMBER, YEAR, and RATING type questions |
questions.allowed_file_types |
any | List of allowed file extensions (e.g., ['.pdf', '.doc', '.docx']). If empty, all file types are allowed. |
questions.allowed_mime_types |
any | List of allowed MIME types (e.g., ['application/pdf', 'application/msword']). If empty, MIME type validation is not enforced. When both extensions and MIME types are specified, files must match both criteria for security. |
questions.max_file_size_mb |
integer | Maximum file size in megabytes. If not set, no size limit is enforced. |
questions.max_files_count |
integer | Maximum number of files allowed for MULTIPLE_FILES type questions. If not set, no count limit is enforced. |
questions.operator |
any | |
questions.review_answer_value |
any | Answer value that trigger review. |
questions.always_requires_review |
boolean | This question always requires review regardless of answer |
questions.guidance_answer_value |
any | Answer value that triggers display of user guidance. |
questions.guidance_operator |
any | Operator to use when comparing answer with guidance_answer_value |
questions.always_show_guidance |
boolean | Show user guidance always, regardless of answer. If False, guidance is conditional on answer matching guidance_answer_value with guidance_operator |
questions.dependency_logic_operator |
any | Defines how multiple dependencies are evaluated. AND: All dependencies must be satisfied. OR: At least one dependency must be satisfied. |
initial_visible_questions |
array of objects | |
initial_visible_questions.uuid |
string (uuid) | |
initial_visible_questions.required |
boolean | |
initial_visible_questions.description |
string | |
initial_visible_questions.user_guidance |
string | Additional guidance text visible to users when answering and reviewing |
initial_visible_questions.question_options |
array of objects | |
initial_visible_questions.question_options.uuid |
string (uuid) | |
initial_visible_questions.question_options.label |
string | |
initial_visible_questions.question_options.order |
integer | |
initial_visible_questions.question_type |
any | Type of question and expected answer format |
initial_visible_questions.order |
integer | |
initial_visible_questions.min_value |
string (decimal) | Minimum value allowed for NUMBER, YEAR, and RATING type questions |
initial_visible_questions.max_value |
string (decimal) | Maximum value allowed for NUMBER, YEAR, and RATING type questions |
initial_visible_questions.allowed_file_types |
any | List of allowed file extensions (e.g., ['.pdf', '.doc', '.docx']). If empty, all file types are allowed. |
initial_visible_questions.allowed_mime_types |
any | List of allowed MIME types (e.g., ['application/pdf', 'application/msword']). If empty, MIME type validation is not enforced. When both extensions and MIME types are specified, files must match both criteria for security. |
initial_visible_questions.max_file_size_mb |
integer | Maximum file size in megabytes. If not set, no size limit is enforced. |
initial_visible_questions.max_files_count |
integer | Maximum number of files allowed for MULTIPLE_FILES type questions. If not set, no count limit is enforced. |
initial_visible_questions.operator |
any | |
initial_visible_questions.review_answer_value |
any | Answer value that trigger review. |
initial_visible_questions.always_requires_review |
boolean | This question always requires review regardless of answer |
initial_visible_questions.guidance_answer_value |
any | Answer value that triggers display of user guidance. |
initial_visible_questions.guidance_operator |
any | Operator to use when comparing answer with guidance_answer_value |
initial_visible_questions.always_show_guidance |
boolean | Show user guidance always, regardless of answer. If False, guidance is conditional on answer matching guidance_answer_value with guidance_operator |
initial_visible_questions.dependency_logic_operator |
any | Defines how multiple dependencies are evaluated. AND: All dependencies must be satisfied. OR: At least one dependency must be satisfied. |
400 -
404 -
Get checklist completion status
Get checklist completion status.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
projects_completion_status_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
is_completed |
boolean | Whether all required questions have been answered |
completion_percentage |
number (double) | |
unanswered_required_questions |
array of anys | |
checklist_name |
string | |
checklist_description |
string | |
created |
string (date-time) | |
modified |
string (date-time) |
400 -
404 -
Submit checklist answers
Submit checklist answers.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
projects_submit_answers
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
The request body is an array of objects, where each object has the following structure:
| Field | Type | Required |
|---|---|---|
question_uuid |
string (uuid) | ✓ |
answer_data |
any | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
detail |
string | |
completion |
object | |
completion.uuid |
string (uuid) | |
completion.is_completed |
boolean | Whether all required questions have been answered |
completion.completion_percentage |
number (double) | |
completion.unanswered_required_questions |
array of anys | |
completion.checklist_name |
string | |
completion.checklist_description |
string | |
completion.created |
string (date-time) | |
completion.modified |
string (date-time) |
400 -
404 -
Remote Actions & Sync
Sync user roles
Trigger user role sync for this project. Sends a notification to RabbitMQ that this project needs user role synchronization.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
projects_sync_user_roles
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string | ✓ |
200 - No response body
Roles
Roles are named collections of permissions that define what a user is allowed to do within a specific scope (either a Customer or a Project). They are the cornerstone of the platform's Role-Based Access Control (RBAC) system.
A user's effective permissions are determined by the combination of their assigned role and the scope to which it applies.
The Permission Triplet
Access control is defined by a triplet: (User, Role, Scope).
-
User: Who is performing the action?
-
Role: What can they do? (e.g.,
Project Administrator,Customer Owner) -
Scope: Where can they do it? (e.g., on "Project Alpha" or across the entire "Customer Inc.")
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/roles/ |
List roles |
| GET | /api/roles/{uuid}/ |
Get role details |
| POST | /api/roles/ |
Create a new role |
| PUT | /api/roles/{uuid}/ |
Update a role |
| PUT | /api/roles/{uuid}/update_descriptions/ |
Update role descriptions |
| PATCH | /api/roles/{uuid}/ |
Partial Update |
| DELETE | /api/roles/{uuid}/ |
Delete a role |
| Other Actions | ||
| POST | /api/roles/{uuid}/disable/ |
Disable a role |
| POST | /api/roles/{uuid}/enable/ |
Enable a role |
Core CRUD
List roles
Get a list of all available roles.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 | |
- Model Source:
RoleDetailsFieldEnum - API Source:
roles_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
description |
string | |
field |
array | |
is_active |
boolean | |
name |
string | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
uuid |
string (uuid) |
name |
string |
description |
string |
description_en |
string |
description_et |
string |
description_lt |
string |
description_lv |
string |
description_ru |
string |
description_it |
string |
description_de |
string |
description_da |
string |
description_sv |
string |
description_es |
string |
description_fr |
string |
description_nb |
string |
description_ar |
string |
description_cs |
string |
permissions |
array of strings |
is_system_role |
boolean |
is_active |
boolean |
users_count |
integer |
content_type |
any |
Get role details
Retrieve the details of a specific role by its UUID.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
RoleDetailsFieldEnum - API Source:
roles_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
name |
string |
description |
string |
description_en |
string |
description_et |
string |
description_lt |
string |
description_lv |
string |
description_ru |
string |
description_it |
string |
description_de |
string |
description_da |
string |
description_sv |
string |
description_es |
string |
description_fr |
string |
description_nb |
string |
description_ar |
string |
description_cs |
string |
permissions |
array of strings |
is_system_role |
boolean |
is_active |
boolean |
users_count |
integer |
content_type |
any |
Create a new role
Allows staff users to create a new custom role with a specific set of permissions.
1 2 3 4 5 6 7 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
RoleModifyRequest - API Source:
roles_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
| Field | Type | Required |
|---|---|---|
name |
string | ✓ |
description |
string | |
description_en |
string | |
description_et |
string | |
description_lt |
string | |
description_lv |
string | |
description_ru |
string | |
description_it |
string | |
description_de |
string | |
description_da |
string | |
description_sv |
string | |
description_es |
string | |
description_fr |
string | |
description_nb |
string | |
description_ar |
string | |
description_cs |
string | |
permissions |
any | ✓ |
is_active |
boolean | |
content_type |
string | ✓ |
201 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
name |
string |
description |
string |
description_en |
string |
description_et |
string |
description_lt |
string |
description_lv |
string |
description_ru |
string |
description_it |
string |
description_de |
string |
description_da |
string |
description_sv |
string |
description_es |
string |
description_fr |
string |
description_nb |
string |
description_ar |
string |
description_cs |
string |
permissions |
array of strings |
is_system_role |
boolean |
is_active |
boolean |
users_count |
integer |
content_type |
any |
Update a role
Allows staff users to update an existing role's name, description, content type, and permissions. The name of a system role cannot be changed.
1 2 3 4 5 6 7 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | |
- Model Source:
RoleModifyRequest - API Source:
roles_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
name |
string | ✓ |
description |
string | |
description_en |
string | |
description_et |
string | |
description_lt |
string | |
description_lv |
string | |
description_ru |
string | |
description_it |
string | |
description_de |
string | |
description_da |
string | |
description_sv |
string | |
description_es |
string | |
description_fr |
string | |
description_nb |
string | |
description_ar |
string | |
description_cs |
string | |
permissions |
any | ✓ |
is_active |
boolean | |
content_type |
string | ✓ |
200 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
name |
string |
description |
string |
description_en |
string |
description_et |
string |
description_lt |
string |
description_lv |
string |
description_ru |
string |
description_it |
string |
description_de |
string |
description_da |
string |
description_sv |
string |
description_es |
string |
description_fr |
string |
description_nb |
string |
description_ar |
string |
description_cs |
string |
permissions |
array of strings |
is_system_role |
boolean |
is_active |
boolean |
users_count |
integer |
content_type |
any |
Update role descriptions
Allows staff users to update the multilingual descriptions of a role.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
RoleDescriptionRequest - API Source:
roles_update_descriptions_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
description |
string | |
description_en |
string | |
description_et |
string | |
description_lt |
string | |
description_lv |
string | |
description_ru |
string | |
description_it |
string | |
description_de |
string | |
description_da |
string | |
description_sv |
string | |
description_es |
string | |
description_fr |
string | |
description_nb |
string | |
description_ar |
string | |
description_cs |
string |
200 -
| Field | Type |
|---|---|
description |
string |
description_en |
string |
description_et |
string |
description_lt |
string |
description_lv |
string |
description_ru |
string |
description_it |
string |
description_de |
string |
description_da |
string |
description_sv |
string |
description_es |
string |
description_fr |
string |
description_nb |
string |
description_ar |
string |
description_cs |
string |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedRoleDetailsRequest - API Source:
roles_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
name |
string | |
description |
string | |
description_en |
string | |
description_et |
string | |
description_lt |
string | |
description_lv |
string | |
description_ru |
string | |
description_it |
string | |
description_de |
string | |
description_da |
string | |
description_sv |
string | |
description_es |
string | |
description_fr |
string | |
description_nb |
string | |
description_ar |
string | |
description_cs |
string | |
is_active |
boolean |
200 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
name |
string |
description |
string |
description_en |
string |
description_et |
string |
description_lt |
string |
description_lv |
string |
description_ru |
string |
description_it |
string |
description_de |
string |
description_da |
string |
description_sv |
string |
description_es |
string |
description_fr |
string |
description_nb |
string |
description_ar |
string |
description_cs |
string |
permissions |
array of strings |
is_system_role |
boolean |
is_active |
boolean |
users_count |
integer |
content_type |
any |
Delete a role
Allows staff users to delete a custom role. System roles and roles that are currently in use cannot be deleted.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
roles_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
Disable a role
Allows staff users to disable a role, preventing it from being assigned further. Existing assignments are not affected.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
roles_disable
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - Role disabled successfully.
Enable a role
Allows staff users to enable a role, making it available for assignment.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
roles_enable
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - Role enabled successfully.
Users
A User represents an individual person's account within the system. It is the primary entity for authentication and identity.
A User object on its own has limited capabilities beyond logging in and managing personal details like SSH keys. Its power comes from the roles and permissions it is granted within the scope of a Customer or Project.
User vs. Permissions
It is crucial to distinguish between the User entity and its permissions. The User API allows for managing the account itself (e.g., name, email), while team management is handled through the add_user actions on the Customer and Project endpoints.
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/users/ |
List Users |
| GET | /api/users/{uuid}/ |
Retrieve |
| POST | /api/users/ |
Create |
| POST | /api/users/{uuid}/pull_remote_user/ |
Synchronize user details from eduTEAMS |
| POST | /api/users/{uuid}/update_actions/ |
Recalculate user actions for a specific user |
| PUT | /api/users/{uuid}/ |
Update |
| PATCH | /api/users/{uuid}/ |
Partial Update |
| DELETE | /api/users/{uuid}/ |
Delete |
| Other Actions | ||
| GET | /api/users/{uuid}/data_access_history/ |
Get user data access history |
| GET | /api/users/{uuid}/data_access/ |
Get user data access visibility |
| GET | /api/users/{uuid}/history/at/ |
Get object state at a specific timestamp |
| GET | /api/users/{uuid}/history/ |
Get version history |
| GET | /api/users/{uuid}/identity_bridge_status/ |
Get identity bridge status for a user |
| GET | /api/users/me/ |
Get current user details |
| GET | /api/users/profile_completeness/ |
Check profile completeness |
| GET | /api/users/{uuid}/token/ |
Get user auth token |
| GET | /api/users/user_active_status_count/ |
Get user counts by active status |
| GET | /api/users/user_language_count/ |
Get user counts by preferred language |
| GET | /api/users/user_registration_trend/ |
Get user registration trends by month |
| POST | /api/users/{uuid}/cancel_change_email/ |
Cancel email change request |
| POST | /api/users/{uuid}/change_email/ |
Request email change |
| POST | /api/users/{uuid}/change_password/ |
Change user password |
| POST | /api/users/confirm_email/ |
Confirm email change |
| POST | /api/users/{uuid}/refresh_token/ |
Refresh user auth token |
| POST | /api/users/scim_sync_all/ |
Trigger SCIM synchronization for all users |
| POST | /api/users/{uuid}/send_notification/ |
Send action notification to a specific user |
Core CRUD
List Users
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- Model Source:
MarketplaceServiceProviderUserOEnum - Model Source:
UserFieldEnum - API Source:
users_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
agreement_date |
string (date-time) | Agreement date after |
civil_number |
string | |
customer_uuid |
string (uuid) | Customer UUID |
date_joined |
string (date-time) | Date joined after |
description |
string | |
email |
string | |
field |
array | |
full_name |
string | Full name |
is_active |
boolean | Is active |
is_staff |
boolean | Is staff |
is_support |
boolean | Is support |
job_title |
string | Job title |
modified |
string (date-time) | Date modified after |
native_name |
string | Native name |
o |
array | Ordering |
organization |
string | Organization |
organization_roles |
string | Organization roles |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
phone_number |
string | |
project_roles |
string | Project roles |
project_uuid |
string (uuid) | Project UUID |
query |
string | Filter by first name, last name, civil number, username or email |
registration_method |
string | |
user_keyword |
string | User keyword |
username |
string | Username (exact) |
username_list |
string | Comma-separated usernames |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
slug |
string | URL-friendly identifier. Only editable by staff users. |
full_name |
string | |
native_name |
string | |
job_title |
string | |
email |
string (email) | |
phone_number |
string | |
organization |
string | |
civil_number |
string | |
description |
string | |
is_staff |
boolean | Designates whether the user can log into this admin site. |
is_active |
boolean | Designates whether this user should be treated as active. Unselect this instead of deleting accounts. |
is_support |
boolean | Designates whether the user is a global support user. |
token |
string | |
token_lifetime |
integer | Token lifetime in seconds. |
token_expires_at |
string (date-time) | |
registration_method |
string | Indicates what registration method was used. |
date_joined |
string (date-time) | |
agreement_date |
string (date-time) | Indicates when the user has agreed with the policy. |
notifications_enabled |
boolean | Designates whether the user is allowed to receive email notifications. |
preferred_language |
string | |
permissions |
array of objects | |
permissions.user_uuid |
string (uuid) | |
permissions.user_name |
string | |
permissions.user_slug |
string | |
permissions.created |
string (date-time) | |
permissions.expiration_time |
string (date-time) | |
permissions.created_by_full_name |
string | |
permissions.created_by_username |
string | |
permissions.role_name |
string | |
permissions.role_description |
string | |
permissions.role_uuid |
string (uuid) | |
permissions.scope_type |
string | |
permissions.scope_uuid |
string (uuid) | |
permissions.scope_name |
string | |
permissions.customer_uuid |
string (uuid) | |
permissions.customer_name |
string | |
requested_email |
string | |
affiliations |
any | Person's affiliation within organization such as student, faculty, staff. |
first_name |
string | |
last_name |
string | |
birth_date |
string (date) | |
identity_provider_name |
string | |
identity_provider_label |
string | |
identity_provider_management_url |
string | |
identity_provider_fields |
array of strings | |
image |
string (uri) | |
identity_source |
string | Indicates what identity provider was used. |
has_active_session |
boolean | |
ip_address |
string | |
gender |
any | ISO 5218 gender code |
personal_title |
string | Honorific title (Mr, Ms, Dr, Prof, etc.) |
place_of_birth |
string | |
country_of_residence |
string | |
nationality |
string | Primary citizenship (ISO 3166-1 alpha-2 code) |
nationalities |
any | List of all citizenships (ISO 3166-1 alpha-2 codes) |
organization_country |
string | |
organization_type |
string | SCHAC URN (e.g., urn:schac:homeOrganizationType:int:university) |
organization_registry_code |
string | Company registration code of the user's organization, if known |
eduperson_assurance |
any | REFEDS assurance profile URIs from identity provider |
is_identity_manager |
boolean | Designates whether the user is allowed to manage remote user identities. |
attribute_sources |
any | Per-attribute source and freshness tracking. Format: {'field_name': {'source': 'isd: |
managed_isds |
any | List of ISD source identifiers this user can manage via Identity Bridge. E.g., ['isd:puhuri', 'isd:fenix']. Non-empty list implies identity manager role. |
active_isds |
any | List of ISDs that have asserted this user exists. User is deactivated when this becomes empty. |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
UserFieldEnum - API Source:
users_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
slug |
string | URL-friendly identifier. Only editable by staff users. |
full_name |
string | |
native_name |
string | |
job_title |
string | |
email |
string (email) | |
phone_number |
string | |
organization |
string | |
civil_number |
string | |
description |
string | |
is_staff |
boolean | Designates whether the user can log into this admin site. |
is_active |
boolean | Designates whether this user should be treated as active. Unselect this instead of deleting accounts. |
is_support |
boolean | Designates whether the user is a global support user. |
token |
string | |
token_lifetime |
integer | Token lifetime in seconds. |
token_expires_at |
string (date-time) | |
registration_method |
string | Indicates what registration method was used. |
date_joined |
string (date-time) | |
agreement_date |
string (date-time) | Indicates when the user has agreed with the policy. |
notifications_enabled |
boolean | Designates whether the user is allowed to receive email notifications. |
preferred_language |
string | |
permissions |
array of objects | |
permissions.user_uuid |
string (uuid) | |
permissions.user_name |
string | |
permissions.user_slug |
string | |
permissions.created |
string (date-time) | |
permissions.expiration_time |
string (date-time) | |
permissions.created_by_full_name |
string | |
permissions.created_by_username |
string | |
permissions.role_name |
string | |
permissions.role_description |
string | |
permissions.role_uuid |
string (uuid) | |
permissions.scope_type |
string | |
permissions.scope_uuid |
string (uuid) | |
permissions.scope_name |
string | |
permissions.customer_uuid |
string (uuid) | |
permissions.customer_name |
string | |
requested_email |
string | |
affiliations |
any | Person's affiliation within organization such as student, faculty, staff. |
first_name |
string | |
last_name |
string | |
birth_date |
string (date) | |
identity_provider_name |
string | |
identity_provider_label |
string | |
identity_provider_management_url |
string | |
identity_provider_fields |
array of strings | |
image |
string (uri) | |
identity_source |
string | Indicates what identity provider was used. |
has_active_session |
boolean | |
ip_address |
string | |
gender |
any | ISO 5218 gender code |
personal_title |
string | Honorific title (Mr, Ms, Dr, Prof, etc.) |
place_of_birth |
string | |
country_of_residence |
string | |
nationality |
string | Primary citizenship (ISO 3166-1 alpha-2 code) |
nationalities |
any | List of all citizenships (ISO 3166-1 alpha-2 codes) |
organization_country |
string | |
organization_type |
string | SCHAC URN (e.g., urn:schac:homeOrganizationType:int:university) |
organization_registry_code |
string | Company registration code of the user's organization, if known |
eduperson_assurance |
any | REFEDS assurance profile URIs from identity provider |
is_identity_manager |
boolean | Designates whether the user is allowed to manage remote user identities. |
attribute_sources |
any | Per-attribute source and freshness tracking. Format: {'field_name': {'source': 'isd: |
managed_isds |
any | List of ISD source identifiers this user can manage via Identity Bridge. E.g., ['isd:puhuri', 'isd:fenix']. Non-empty list implies identity manager role. |
active_isds |
any | List of ISDs that have asserted this user exists. User is deactivated when this becomes empty. |
Create
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
UserRequest - API Source:
users_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Field | Type | Required | Description |
|---|---|---|---|
username |
string | ✓ | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
slug |
string | URL-friendly identifier. Only editable by staff users. | |
native_name |
string | ||
job_title |
string | ||
email |
string (email) | ✓ | |
phone_number |
string | ||
organization |
string | ||
description |
string | ||
is_staff |
boolean | Designates whether the user can log into this admin site. | |
is_active |
boolean | Designates whether this user should be treated as active. Unselect this instead of deleting accounts. | |
is_support |
boolean | Designates whether the user is a global support user. | |
token_lifetime |
integer | Token lifetime in seconds. | |
agree_with_policy |
boolean | User must agree with the policy to register. Constraints: write-only |
|
notifications_enabled |
boolean | Designates whether the user is allowed to receive email notifications. | |
preferred_language |
string | ||
first_name |
string | ||
last_name |
string | ||
birth_date |
string (date) | ||
image |
string (binary) | ||
gender |
any | ISO 5218 gender code | |
personal_title |
string | Honorific title (Mr, Ms, Dr, Prof, etc.) | |
place_of_birth |
string | ||
country_of_residence |
string | ||
nationality |
string | Primary citizenship (ISO 3166-1 alpha-2 code) | |
nationalities |
any | List of all citizenships (ISO 3166-1 alpha-2 codes) | |
organization_country |
string | ||
organization_type |
string | SCHAC URN (e.g., urn:schac:homeOrganizationType:int:university) | |
organization_registry_code |
string | Company registration code of the user's organization, if known | |
eduperson_assurance |
any | REFEDS assurance profile URIs from identity provider | |
is_identity_manager |
boolean | Designates whether the user is allowed to manage remote user identities. | |
managed_isds |
any | List of ISD source identifiers this user can manage via Identity Bridge. E.g., ['isd:puhuri', 'isd:fenix']. Non-empty list implies identity manager role. |
201 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
slug |
string | URL-friendly identifier. Only editable by staff users. |
full_name |
string | |
native_name |
string | |
job_title |
string | |
email |
string (email) | |
phone_number |
string | |
organization |
string | |
civil_number |
string | |
description |
string | |
is_staff |
boolean | Designates whether the user can log into this admin site. |
is_active |
boolean | Designates whether this user should be treated as active. Unselect this instead of deleting accounts. |
is_support |
boolean | Designates whether the user is a global support user. |
token |
string | |
token_lifetime |
integer | Token lifetime in seconds. |
token_expires_at |
string (date-time) | |
registration_method |
string | Indicates what registration method was used. |
date_joined |
string (date-time) | |
agreement_date |
string (date-time) | Indicates when the user has agreed with the policy. |
notifications_enabled |
boolean | Designates whether the user is allowed to receive email notifications. |
preferred_language |
string | |
permissions |
array of objects | |
permissions.user_uuid |
string (uuid) | |
permissions.user_name |
string | |
permissions.user_slug |
string | |
permissions.created |
string (date-time) | |
permissions.expiration_time |
string (date-time) | |
permissions.created_by_full_name |
string | |
permissions.created_by_username |
string | |
permissions.role_name |
string | |
permissions.role_description |
string | |
permissions.role_uuid |
string (uuid) | |
permissions.scope_type |
string | |
permissions.scope_uuid |
string (uuid) | |
permissions.scope_name |
string | |
permissions.customer_uuid |
string (uuid) | |
permissions.customer_name |
string | |
requested_email |
string | |
affiliations |
any | Person's affiliation within organization such as student, faculty, staff. |
first_name |
string | |
last_name |
string | |
birth_date |
string (date) | |
identity_provider_name |
string | |
identity_provider_label |
string | |
identity_provider_management_url |
string | |
identity_provider_fields |
array of strings | |
image |
string (uri) | |
identity_source |
string | Indicates what identity provider was used. |
has_active_session |
boolean | |
ip_address |
string | |
gender |
any | ISO 5218 gender code |
personal_title |
string | Honorific title (Mr, Ms, Dr, Prof, etc.) |
place_of_birth |
string | |
country_of_residence |
string | |
nationality |
string | Primary citizenship (ISO 3166-1 alpha-2 code) |
nationalities |
any | List of all citizenships (ISO 3166-1 alpha-2 codes) |
organization_country |
string | |
organization_type |
string | SCHAC URN (e.g., urn:schac:homeOrganizationType:int:university) |
organization_registry_code |
string | Company registration code of the user's organization, if known |
eduperson_assurance |
any | REFEDS assurance profile URIs from identity provider |
is_identity_manager |
boolean | Designates whether the user is allowed to manage remote user identities. |
attribute_sources |
any | Per-attribute source and freshness tracking. Format: {'field_name': {'source': 'isd: |
managed_isds |
any | List of ISD source identifiers this user can manage via Identity Bridge. E.g., ['isd:puhuri', 'isd:fenix']. Non-empty list implies identity manager role. |
active_isds |
any | List of ISDs that have asserted this user exists. User is deactivated when this becomes empty. |
Synchronize user details from eduTEAMS
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
users_pull_remote_user
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - No response body
Recalculate user actions for a specific user
Staff-only action to trigger recalculation of user actions for a specific user.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
UpdateActionsRequest - API Source:
users_update_actions
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
provider_action_type |
string | Optional provider action type to update. If not provided, updates all providers. |
202 -
| Field | Type |
|---|---|
status |
string |
message |
string |
provider_action_type |
string |
Update
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
UserRequest - API Source:
users_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
username |
string | ✓ | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
slug |
string | URL-friendly identifier. Only editable by staff users. | |
native_name |
string | ||
job_title |
string | ||
email |
string (email) | ✓ | |
phone_number |
string | ||
organization |
string | ||
description |
string | ||
is_staff |
boolean | Designates whether the user can log into this admin site. | |
is_active |
boolean | Designates whether this user should be treated as active. Unselect this instead of deleting accounts. | |
is_support |
boolean | Designates whether the user is a global support user. | |
token_lifetime |
integer | Token lifetime in seconds. | |
agree_with_policy |
boolean | User must agree with the policy to register. Constraints: write-only |
|
notifications_enabled |
boolean | Designates whether the user is allowed to receive email notifications. | |
preferred_language |
string | ||
first_name |
string | ||
last_name |
string | ||
birth_date |
string (date) | ||
image |
string (binary) | ||
gender |
any | ISO 5218 gender code | |
personal_title |
string | Honorific title (Mr, Ms, Dr, Prof, etc.) | |
place_of_birth |
string | ||
country_of_residence |
string | ||
nationality |
string | Primary citizenship (ISO 3166-1 alpha-2 code) | |
nationalities |
any | List of all citizenships (ISO 3166-1 alpha-2 codes) | |
organization_country |
string | ||
organization_type |
string | SCHAC URN (e.g., urn:schac:homeOrganizationType:int:university) | |
organization_registry_code |
string | Company registration code of the user's organization, if known | |
eduperson_assurance |
any | REFEDS assurance profile URIs from identity provider | |
is_identity_manager |
boolean | Designates whether the user is allowed to manage remote user identities. | |
managed_isds |
any | List of ISD source identifiers this user can manage via Identity Bridge. E.g., ['isd:puhuri', 'isd:fenix']. Non-empty list implies identity manager role. |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
slug |
string | URL-friendly identifier. Only editable by staff users. |
full_name |
string | |
native_name |
string | |
job_title |
string | |
email |
string (email) | |
phone_number |
string | |
organization |
string | |
civil_number |
string | |
description |
string | |
is_staff |
boolean | Designates whether the user can log into this admin site. |
is_active |
boolean | Designates whether this user should be treated as active. Unselect this instead of deleting accounts. |
is_support |
boolean | Designates whether the user is a global support user. |
token |
string | |
token_lifetime |
integer | Token lifetime in seconds. |
token_expires_at |
string (date-time) | |
registration_method |
string | Indicates what registration method was used. |
date_joined |
string (date-time) | |
agreement_date |
string (date-time) | Indicates when the user has agreed with the policy. |
notifications_enabled |
boolean | Designates whether the user is allowed to receive email notifications. |
preferred_language |
string | |
permissions |
array of objects | |
permissions.user_uuid |
string (uuid) | |
permissions.user_name |
string | |
permissions.user_slug |
string | |
permissions.created |
string (date-time) | |
permissions.expiration_time |
string (date-time) | |
permissions.created_by_full_name |
string | |
permissions.created_by_username |
string | |
permissions.role_name |
string | |
permissions.role_description |
string | |
permissions.role_uuid |
string (uuid) | |
permissions.scope_type |
string | |
permissions.scope_uuid |
string (uuid) | |
permissions.scope_name |
string | |
permissions.customer_uuid |
string (uuid) | |
permissions.customer_name |
string | |
requested_email |
string | |
affiliations |
any | Person's affiliation within organization such as student, faculty, staff. |
first_name |
string | |
last_name |
string | |
birth_date |
string (date) | |
identity_provider_name |
string | |
identity_provider_label |
string | |
identity_provider_management_url |
string | |
identity_provider_fields |
array of strings | |
image |
string (uri) | |
identity_source |
string | Indicates what identity provider was used. |
has_active_session |
boolean | |
ip_address |
string | |
gender |
any | ISO 5218 gender code |
personal_title |
string | Honorific title (Mr, Ms, Dr, Prof, etc.) |
place_of_birth |
string | |
country_of_residence |
string | |
nationality |
string | Primary citizenship (ISO 3166-1 alpha-2 code) |
nationalities |
any | List of all citizenships (ISO 3166-1 alpha-2 codes) |
organization_country |
string | |
organization_type |
string | SCHAC URN (e.g., urn:schac:homeOrganizationType:int:university) |
organization_registry_code |
string | Company registration code of the user's organization, if known |
eduperson_assurance |
any | REFEDS assurance profile URIs from identity provider |
is_identity_manager |
boolean | Designates whether the user is allowed to manage remote user identities. |
attribute_sources |
any | Per-attribute source and freshness tracking. Format: {'field_name': {'source': 'isd: |
managed_isds |
any | List of ISD source identifiers this user can manage via Identity Bridge. E.g., ['isd:puhuri', 'isd:fenix']. Non-empty list implies identity manager role. |
active_isds |
any | List of ISDs that have asserted this user exists. User is deactivated when this becomes empty. |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedUserRequest - API Source:
users_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters | |
slug |
string | URL-friendly identifier. Only editable by staff users. | |
native_name |
string | ||
job_title |
string | ||
phone_number |
string | ||
organization |
string | ||
description |
string | ||
is_staff |
boolean | Designates whether the user can log into this admin site. | |
is_active |
boolean | Designates whether this user should be treated as active. Unselect this instead of deleting accounts. | |
is_support |
boolean | Designates whether the user is a global support user. | |
token_lifetime |
integer | Token lifetime in seconds. | |
agree_with_policy |
boolean | User must agree with the policy to register. Constraints: write-only |
|
notifications_enabled |
boolean | Designates whether the user is allowed to receive email notifications. | |
preferred_language |
string | ||
first_name |
string | ||
last_name |
string | ||
birth_date |
string (date) | ||
image |
string (binary) | ||
gender |
any | ISO 5218 gender code | |
personal_title |
string | Honorific title (Mr, Ms, Dr, Prof, etc.) | |
place_of_birth |
string | ||
country_of_residence |
string | ||
nationality |
string | Primary citizenship (ISO 3166-1 alpha-2 code) | |
nationalities |
any | List of all citizenships (ISO 3166-1 alpha-2 codes) | |
organization_country |
string | ||
organization_type |
string | SCHAC URN (e.g., urn:schac:homeOrganizationType:int:university) | |
organization_registry_code |
string | Company registration code of the user's organization, if known | |
eduperson_assurance |
any | REFEDS assurance profile URIs from identity provider | |
is_identity_manager |
boolean | Designates whether the user is allowed to manage remote user identities. | |
managed_isds |
any | List of ISD source identifiers this user can manage via Identity Bridge. E.g., ['isd:puhuri', 'isd:fenix']. Non-empty list implies identity manager role. |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
slug |
string | URL-friendly identifier. Only editable by staff users. |
full_name |
string | |
native_name |
string | |
job_title |
string | |
email |
string (email) | |
phone_number |
string | |
organization |
string | |
civil_number |
string | |
description |
string | |
is_staff |
boolean | Designates whether the user can log into this admin site. |
is_active |
boolean | Designates whether this user should be treated as active. Unselect this instead of deleting accounts. |
is_support |
boolean | Designates whether the user is a global support user. |
token |
string | |
token_lifetime |
integer | Token lifetime in seconds. |
token_expires_at |
string (date-time) | |
registration_method |
string | Indicates what registration method was used. |
date_joined |
string (date-time) | |
agreement_date |
string (date-time) | Indicates when the user has agreed with the policy. |
notifications_enabled |
boolean | Designates whether the user is allowed to receive email notifications. |
preferred_language |
string | |
permissions |
array of objects | |
permissions.user_uuid |
string (uuid) | |
permissions.user_name |
string | |
permissions.user_slug |
string | |
permissions.created |
string (date-time) | |
permissions.expiration_time |
string (date-time) | |
permissions.created_by_full_name |
string | |
permissions.created_by_username |
string | |
permissions.role_name |
string | |
permissions.role_description |
string | |
permissions.role_uuid |
string (uuid) | |
permissions.scope_type |
string | |
permissions.scope_uuid |
string (uuid) | |
permissions.scope_name |
string | |
permissions.customer_uuid |
string (uuid) | |
permissions.customer_name |
string | |
requested_email |
string | |
affiliations |
any | Person's affiliation within organization such as student, faculty, staff. |
first_name |
string | |
last_name |
string | |
birth_date |
string (date) | |
identity_provider_name |
string | |
identity_provider_label |
string | |
identity_provider_management_url |
string | |
identity_provider_fields |
array of strings | |
image |
string (uri) | |
identity_source |
string | Indicates what identity provider was used. |
has_active_session |
boolean | |
ip_address |
string | |
gender |
any | ISO 5218 gender code |
personal_title |
string | Honorific title (Mr, Ms, Dr, Prof, etc.) |
place_of_birth |
string | |
country_of_residence |
string | |
nationality |
string | Primary citizenship (ISO 3166-1 alpha-2 code) |
nationalities |
any | List of all citizenships (ISO 3166-1 alpha-2 codes) |
organization_country |
string | |
organization_type |
string | SCHAC URN (e.g., urn:schac:homeOrganizationType:int:university) |
organization_registry_code |
string | Company registration code of the user's organization, if known |
eduperson_assurance |
any | REFEDS assurance profile URIs from identity provider |
is_identity_manager |
boolean | Designates whether the user is allowed to manage remote user identities. |
attribute_sources |
any | Per-attribute source and freshness tracking. Format: {'field_name': {'source': 'isd: |
managed_isds |
any | List of ISD source identifiers this user can manage via Identity Bridge. E.g., ['isd:puhuri', 'isd:fenix']. Non-empty list implies identity manager role. |
active_isds |
any | List of ISDs that have asserted this user exists. User is deactivated when this becomes empty. |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
users_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
Get user data access history
Shows historical log of who has accessed the user's profile data. Regular users see anonymized accessor categories. Staff/support see full details including accessor identity, IP, and context.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
- Model Source:
MarketplaceServiceProviderUserOEnum - API Source:
users_data_access_history_list
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
accessor_type |
string | Filter by accessor type (staff, support, organization_member, self) |
agreement_date |
string (date-time) | Agreement date after |
civil_number |
string | |
customer_uuid |
string (uuid) | Customer UUID |
date_joined |
string (date-time) | Date joined after |
description |
string | |
email |
string | |
end_date |
string (date) | Filter logs until this date (inclusive) |
full_name |
string | Full name |
is_active |
boolean | Is active |
is_staff |
boolean | Is staff |
is_support |
boolean | Is support |
job_title |
string | Job title |
modified |
string (date-time) | Date modified after |
native_name |
string | Native name |
o |
array | Ordering |
organization |
string | Organization |
organization_roles |
string | Organization roles |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
phone_number |
string | |
project_roles |
string | Project roles |
project_uuid |
string (uuid) | Project UUID |
query |
string | Filter by first name, last name, civil number, username or email |
registration_method |
string | |
start_date |
string (date) | Filter logs from this date (inclusive) |
user_keyword |
string | User keyword |
username |
string | Username (exact) |
username_list |
string | Comma-separated usernames |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
timestamp |
string (date-time) | |
accessor_type |
string | Enum: staff, support, organization_member, service_provider, self |
accessed_fields |
array of strings | |
accessor_category |
string | |
accessor |
object | |
accessor.uuid |
string (uuid) | |
accessor.username |
string | |
accessor.full_name |
string | |
ip_address |
any | An IPv4 or IPv6 address. |
context |
object (free-form) |
Get user data access visibility
Shows who has access to the user's profile data. Includes administrative access (staff/support), organizational access (same customer/project), and service provider access (via consent). Regular users see counts for admin access; staff/support see individual records.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
users_data_access_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
administrative_access |
object |
administrative_access.description |
string |
administrative_access.staff_count |
integer |
administrative_access.support_count |
integer |
administrative_access.users |
array of objects |
administrative_access.users.user_uuid |
string (uuid) |
administrative_access.users.username |
string |
administrative_access.users.full_name |
string |
administrative_access.users.access_type |
string |
organizational_access |
array of objects |
organizational_access.scope_type |
string |
organizational_access.scope_uuid |
string (uuid) |
organizational_access.scope_name |
string |
organizational_access.users |
array of objects |
organizational_access.users.user_uuid |
string (uuid) |
organizational_access.users.username |
string |
organizational_access.users.full_name |
string |
organizational_access.users.role |
string |
service_provider_access |
array of objects |
service_provider_access.offering_uuid |
string (uuid) |
service_provider_access.offering_name |
string |
service_provider_access.provider_name |
string |
service_provider_access.provider_uuid |
string (uuid) |
service_provider_access.exposed_fields |
array of strings |
service_provider_access.consent_date |
string |
service_provider_access.consent_version |
string |
service_provider_access.provider_team |
array of objects |
service_provider_access.provider_team.user_uuid |
string (uuid) |
service_provider_access.provider_team.username |
string |
service_provider_access.provider_team.full_name |
string |
service_provider_access.provider_team.role |
string |
summary |
object |
summary.total_administrative_access |
integer |
summary.total_organizational_access |
integer |
summary.total_provider_access |
integer |
Get object state at a specific timestamp
Returns the state of the object as it was at the specified timestamp. Only accessible by staff and support users.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- API Source:
users_history_at_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Required | Description |
|---|---|---|---|
timestamp |
string | ✓ | ISO 8601 timestamp to query the object state at |
200 -
| Field | Type | Description |
|---|---|---|
id |
integer | Version ID |
revision_date |
string (date-time) | When this revision was created |
revision_user |
object (free-form) | User who created this revision |
revision_comment |
string | Comment describing the revision |
serialized_data |
object (free-form) | Serialized model fields at this revision |
400 -
404 -
Get version history
Returns the version history for this object. Only accessible by staff and support users.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
- Model Source:
MarketplaceServiceProviderUserOEnum - API Source:
users_history_list
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
agreement_date |
string (date-time) | Agreement date after |
civil_number |
string | |
created_after |
string | Filter versions created after this timestamp (ISO 8601) |
created_before |
string | Filter versions created before this timestamp (ISO 8601) |
customer_uuid |
string (uuid) | Customer UUID |
date_joined |
string (date-time) | Date joined after |
description |
string | |
email |
string | |
full_name |
string | Full name |
is_active |
boolean | Is active |
is_staff |
boolean | Is staff |
is_support |
boolean | Is support |
job_title |
string | Job title |
modified |
string (date-time) | Date modified after |
native_name |
string | Native name |
o |
array | Ordering |
organization |
string | Organization |
organization_roles |
string | Organization roles |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
phone_number |
string | |
project_roles |
string | Project roles |
project_uuid |
string (uuid) | Project UUID |
query |
string | Filter by first name, last name, civil number, username or email |
registration_method |
string | |
user_keyword |
string | User keyword |
username |
string | Username (exact) |
username_list |
string | Comma-separated usernames |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
id |
integer | Version ID |
revision_date |
string (date-time) | When this revision was created |
revision_user |
object (free-form) | User who created this revision |
revision_comment |
string | Comment describing the revision |
serialized_data |
object (free-form) | Serialized model fields at this revision |
Get identity bridge status for a user
Returns diagnostic information about a user's identity bridge state: active ISDs, per-attribute source tracking with staleness detection, and effective bridge-writable fields. Staff only.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
users_identity_bridge_status_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
active_isds |
array of strings |
managed_isds |
array of strings |
attribute_sources |
object (free-form) |
stale_attributes |
array of strings |
effective_bridge_fields |
array of strings |
is_federated |
boolean |
Get current user details
Get current user details, including authentication token and profile completeness status.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- Model Source:
UserFieldEnum - API Source:
users_me_retrieve
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
slug |
string | URL-friendly identifier. Only editable by staff users. |
full_name |
string | |
native_name |
string | |
job_title |
string | |
email |
string (email) | |
phone_number |
string | |
organization |
string | |
civil_number |
string | |
description |
string | |
is_staff |
boolean | Designates whether the user can log into this admin site. |
is_active |
boolean | Designates whether this user should be treated as active. Unselect this instead of deleting accounts. |
is_support |
boolean | Designates whether the user is a global support user. |
token |
string | |
token_lifetime |
integer | Token lifetime in seconds. |
token_expires_at |
string (date-time) | |
registration_method |
string | Indicates what registration method was used. |
date_joined |
string (date-time) | |
agreement_date |
string (date-time) | Indicates when the user has agreed with the policy. |
notifications_enabled |
boolean | Designates whether the user is allowed to receive email notifications. |
preferred_language |
string | |
permissions |
array of objects | |
permissions.user_uuid |
string (uuid) | |
permissions.user_name |
string | |
permissions.user_slug |
string | |
permissions.created |
string (date-time) | |
permissions.expiration_time |
string (date-time) | |
permissions.created_by_full_name |
string | |
permissions.created_by_username |
string | |
permissions.role_name |
string | |
permissions.role_description |
string | |
permissions.role_uuid |
string (uuid) | |
permissions.scope_type |
string | |
permissions.scope_uuid |
string (uuid) | |
permissions.scope_name |
string | |
permissions.customer_uuid |
string (uuid) | |
permissions.customer_name |
string | |
requested_email |
string | |
affiliations |
any | Person's affiliation within organization such as student, faculty, staff. |
first_name |
string | |
last_name |
string | |
birth_date |
string (date) | |
identity_provider_name |
string | |
identity_provider_label |
string | |
identity_provider_management_url |
string | |
identity_provider_fields |
array of strings | |
image |
string (uri) | |
identity_source |
string | Indicates what identity provider was used. |
has_active_session |
boolean | |
ip_address |
string | |
gender |
any | ISO 5218 gender code |
personal_title |
string | Honorific title (Mr, Ms, Dr, Prof, etc.) |
place_of_birth |
string | |
country_of_residence |
string | |
nationality |
string | Primary citizenship (ISO 3166-1 alpha-2 code) |
nationalities |
any | List of all citizenships (ISO 3166-1 alpha-2 codes) |
organization_country |
string | |
organization_type |
string | SCHAC URN (e.g., urn:schac:homeOrganizationType:int:university) |
organization_registry_code |
string | Company registration code of the user's organization, if known |
eduperson_assurance |
any | REFEDS assurance profile URIs from identity provider |
is_identity_manager |
boolean | Designates whether the user is allowed to manage remote user identities. |
attribute_sources |
any | Per-attribute source and freshness tracking. Format: {'field_name': {'source': 'isd: |
managed_isds |
any | List of ISD source identifiers this user can manage via Identity Bridge. E.g., ['isd:puhuri', 'isd:fenix']. Non-empty list implies identity manager role. |
active_isds |
any | List of ISDs that have asserted this user exists. User is deactivated when this becomes empty. |
Check profile completeness
Check if user profile is complete with all mandatory attributes.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
- API Source:
users_profile_completeness_retrieve
1 2 3 4 5 6 7 8 9 10 | |
200 -
| Field | Type | Description |
|---|---|---|
is_complete |
boolean | Whether all mandatory profile fields are filled. |
missing_fields |
array of strings | List of mandatory fields that are missing. |
mandatory_fields |
array of strings | List of all mandatory fields. |
enforcement_enabled |
boolean | Whether enforcement of mandatory attributes is enabled. |
Get user auth token
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
users_token_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
created |
string (date-time) | |
user_first_name |
string | |
user_last_name |
string | |
user_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
user_is_active |
boolean | Designates whether this user should be treated as active. Unselect this instead of deleting accounts. |
user_token_lifetime |
integer | Token lifetime in seconds. |
token |
string |
Get user counts by active status
Returns aggregated counts of users by active/inactive status. Staff or support only.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 | |
- Model Source:
MarketplaceServiceProviderUserOEnum - API Source:
users_user_active_status_count_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
agreement_date |
string (date-time) | Agreement date after |
civil_number |
string | |
customer_uuid |
string (uuid) | Customer UUID |
date_joined |
string (date-time) | Date joined after |
description |
string | |
email |
string | |
full_name |
string | Full name |
is_active |
boolean | Is active |
is_staff |
boolean | Is staff |
is_support |
boolean | Is support |
job_title |
string | Job title |
modified |
string (date-time) | Date modified after |
native_name |
string | Native name |
o |
array | Ordering |
organization |
string | Organization |
organization_roles |
string | Organization roles |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
phone_number |
string | |
project_roles |
string | Project roles |
project_uuid |
string (uuid) | Project UUID |
query |
string | Filter by first name, last name, civil number, username or email |
registration_method |
string | |
user_keyword |
string | User keyword |
username |
string | Username (exact) |
username_list |
string | Comma-separated usernames |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
status |
string |
count |
integer |
Get user counts by preferred language
Returns aggregated counts of users by preferred language. Staff or support only.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 | |
- Model Source:
MarketplaceServiceProviderUserOEnum - API Source:
users_user_language_count_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
agreement_date |
string (date-time) | Agreement date after |
civil_number |
string | |
customer_uuid |
string (uuid) | Customer UUID |
date_joined |
string (date-time) | Date joined after |
description |
string | |
email |
string | |
full_name |
string | Full name |
is_active |
boolean | Is active |
is_staff |
boolean | Is staff |
is_support |
boolean | Is support |
job_title |
string | Job title |
modified |
string (date-time) | Date modified after |
native_name |
string | Native name |
o |
array | Ordering |
organization |
string | Organization |
organization_roles |
string | Organization roles |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
phone_number |
string | |
project_roles |
string | Project roles |
project_uuid |
string (uuid) | Project UUID |
query |
string | Filter by first name, last name, civil number, username or email |
registration_method |
string | |
user_keyword |
string | User keyword |
username |
string | Username (exact) |
username_list |
string | Comma-separated usernames |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
language |
string |
count |
integer |
Get user registration trends by month
Returns user registration counts aggregated by month. Staff or support only.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 | |
- Model Source:
MarketplaceServiceProviderUserOEnum - API Source:
users_user_registration_trend_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
agreement_date |
string (date-time) | Agreement date after |
civil_number |
string | |
customer_uuid |
string (uuid) | Customer UUID |
date_joined |
string (date-time) | Date joined after |
description |
string | |
email |
string | |
full_name |
string | Full name |
is_active |
boolean | Is active |
is_staff |
boolean | Is staff |
is_support |
boolean | Is support |
job_title |
string | Job title |
modified |
string (date-time) | Date modified after |
native_name |
string | Native name |
o |
array | Ordering |
organization |
string | Organization |
organization_roles |
string | Organization roles |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
phone_number |
string | |
project_roles |
string | Project roles |
project_uuid |
string (uuid) | Project UUID |
query |
string | Filter by first name, last name, civil number, username or email |
registration_method |
string | |
user_keyword |
string | User keyword |
username |
string | Username (exact) |
username_list |
string | Comma-separated usernames |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
month |
string |
count |
integer |
Cancel email change request
Cancel email update request
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
users_cancel_change_email
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - No response body
Request email change
Allows to change email for user.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
UserEmailChangeRequest - API Source:
users_change_email
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
email |
string (email) | ✓ |
200 - No response body
Change user password
Allows staff user to change password for any user.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
PasswordChangeRequest - API Source:
users_change_password
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
new_password |
string | ✓ |
200 - No response body
Confirm email change
Confirm email update using code
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
- Model Source:
ConfirmEmailRequestRequest - API Source:
users_confirm_email
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Field | Type | Required |
|---|---|---|
code |
string | ✓ |
200 - No response body
Refresh user auth token
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
users_refresh_token
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
created |
string (date-time) | |
user_first_name |
string | |
user_last_name |
string | |
user_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
user_is_active |
boolean | Designates whether this user should be treated as active. Unselect this instead of deleting accounts. |
user_token_lifetime |
integer | Token lifetime in seconds. |
token |
string |
Trigger SCIM synchronization for all users
Staff-only action to queue SCIM synchronization for all users.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
- API Source:
users_scim_sync_all
1 2 3 4 5 6 7 8 9 10 | |
200 -
| Field | Type |
|---|---|
detail |
string |
Send action notification to a specific user
Staff-only action to send a pending actions digest notification to a specific user.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
users_send_notification
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
202 -
| Field | Type |
|---|---|
status |
string |
message |
string |
System configuration
Celery Stats
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/celery-stats/ |
Get Celery worker statistics |
Get Celery worker statistics
Provides a comprehensive snapshot of all Celery workers' status.
This endpoint returns detailed information about: - active: Tasks currently being executed by workers - scheduled: Tasks scheduled for future execution (with ETA) - reserved: Tasks received by workers but not yet started - revoked: Task IDs that have been cancelled/revoked - query_task: Results of task queries (if any) - stats: Detailed worker statistics including uptime, pool info, and broker connection
Each field is a dictionary where keys are worker names (e.g., 'celery@hostname').
If no workers are available, fields will be null.
Requires support user permissions.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
- API Source:
celery_stats_retrieve
1 2 3 4 5 6 7 8 9 10 | |
200 -
| Field | Type | Description |
|---|---|---|
active |
object (free-form) | Currently executing tasks per worker. Keys are worker names, values are lists of active tasks. |
scheduled |
object (free-form) | Tasks scheduled for future execution per worker. Keys are worker names, values are lists of scheduled tasks with ETA. |
reserved |
object (free-form) | Tasks that have been received but not yet started per worker. Keys are worker names, values are lists of reserved tasks. |
revoked |
object (free-form) | IDs of revoked (cancelled) tasks per worker. Keys are worker names, values are lists of task IDs. |
query_task |
object (free-form) | Query results for specific tasks. May be null if no query was performed. |
stats |
object (free-form) | Detailed statistics per worker including uptime, pool info, and resource usage. Keys are worker names. |
Configuration
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/configuration/ |
Get public configuration |
Get public configuration
Returns a dictionary of public settings for the Waldur deployment. This includes feature flags, authentication methods, and other configuration details that are safe to expose to any user.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
- API Source:
configuration_retrieve
1 2 3 4 5 6 7 8 9 10 | |
200 -
Database Stats
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/database-stats/ |
Get comprehensive database statistics |
Get comprehensive database statistics
Retrieves comprehensive statistics about the PostgreSQL database including: - Table statistics: Top 10 largest tables by size - Connection statistics: Active, idle, and waiting connections with utilization - Database size: Total size, data size, and index size - Cache performance: Buffer cache and index hit ratios (should be >99%) - Transaction statistics: Commits, rollbacks, deadlocks - Lock statistics: Current locks and waiting queries - Maintenance statistics: Dead tuples, vacuum needs, oldest transaction age - Active queries: Currently running queries with duration - Query performance: Sequential vs index scan ratios - Replication status: WAL size and replication lag (if applicable)
This information is useful for monitoring, debugging, and performance tuning. Requires support user permissions.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
- API Source:
database_stats_retrieve
1 2 3 4 5 6 7 8 9 10 | |
200 -
| Field | Type | Description |
|---|---|---|
table_stats |
array of objects | Top largest tables by size |
table_stats.table_name |
string | Name of the database table |
table_stats.total_size |
integer | Total size of the table in bytes |
table_stats.data_size |
integer | Size of the actual data in bytes |
table_stats.external_size |
integer | Size of external data (e.g., TOAST) in bytes |
connections |
any | Connection statistics |
database_size |
any | Database size information |
cache_performance |
any | Cache hit ratios and memory settings |
transactions |
any | Transaction commit/rollback statistics |
locks |
any | Current lock statistics |
maintenance |
any | Vacuum and maintenance statistics |
active_queries |
any | Currently running queries |
query_performance |
any | Query performance indicators |
replication |
any | Replication status (if applicable) |
Debug
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/debug/pubsub/circuit_breaker/ |
Get circuit breaker state |
| GET | /api/debug/pubsub/dead_letter_queue/ |
Get dead letter queue status |
| GET | /api/debug/pubsub/message_state_cache/ |
Get message state cache statistics |
| GET | /api/debug/pubsub/metrics/ |
Get publishing metrics |
| GET | /api/debug/pubsub/overview/ |
Get pubsub system health overview |
| GET | /api/debug/pubsub/queues/ |
Get subscription queues overview |
| POST | /api/debug/pubsub/circuit_breaker_reset/ |
Reset circuit breaker |
| POST | /api/debug/pubsub/metrics_reset/ |
Reset publishing metrics |
Get circuit breaker state
Get current STOMP circuit breaker state and statistics.
Returns: - state: Current state (closed/open/half_open) - failure_count: Number of consecutive failures - success_count: Successes since last state change - last_failure_time: Timestamp of last failure - last_state_change: When state last changed - config: Circuit breaker configuration - state_history: Recent state transitions
Requires staff permissions.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
- API Source:
debug_pubsub_circuit_breaker_retrieve
1 2 3 4 5 6 7 8 9 10 | |
200 -
| Field | Type | Description |
|---|---|---|
state |
string | Current state: closed, open, or half_open |
failure_count |
integer | Number of consecutive failures |
success_count |
integer | Successful calls since last state change |
last_failure_time |
number (double) | Unix timestamp of last failure |
last_state_change |
number (double) | Unix timestamp of last state change |
config |
any | Circuit breaker configuration |
state_history |
array of objects | Recent state transitions (last 50) |
state_history.timestamp |
number (double) | Unix timestamp of state change |
state_history.from_state |
string | Previous state |
state_history.to_state |
string | New state |
state_history.reason |
string | Reason for state change |
Get dead letter queue status
Get dead letter queue (DLQ) statistics.
The DLQ receives messages that failed to be delivered to their original destination. This endpoint shows the current DLQ status.
Note: DLQ is configured per-vhost. This endpoint checks all vhosts for queues with 'dlq' in the name.
Requires staff permissions.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
- API Source:
debug_pubsub_dead_letter_queue_retrieve
1 2 3 4 5 6 7 8 9 10 | |
200 -
| Field | Type | Description |
|---|---|---|
total_dlq_messages |
integer | Total messages across all DLQs |
dlq_count |
integer | Number of DLQ queues found |
dlq_queues |
array of objects | List of DLQ queues with their statistics |
dlq_queues.vhost |
string | Virtual host name |
dlq_queues.queue_name |
string | DLQ queue name |
dlq_queues.messages |
integer | Total messages in DLQ |
dlq_queues.messages_ready |
integer | Messages ready for delivery |
dlq_queues.consumers |
integer | Number of consumers attached |
note |
string | Informational note about DLQs |
503 -
| Field | Type | Description |
|---|---|---|
error |
string | Error message describing what went wrong |
Get message state cache statistics
Get message state tracker cache statistics for idempotency.
The message state tracker prevents duplicate message sends by caching the hash of message content. This endpoint provides cache statistics.
Query params: - resource_uuid: Filter by specific resource - message_type: Filter by message type
Requires staff permissions.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
- API Source:
debug_pubsub_message_state_cache_retrieve
1 2 3 4 5 6 7 8 9 10 | |
200 -
| Field | Type | Description |
|---|---|---|
cache_ttl |
integer | Cache TTL in seconds |
description |
string | Cache description |
filter |
any | Applied filters |
Get publishing metrics
Get message publishing metrics and statistics.
Returns: - messages_sent: Total messages successfully sent - messages_failed: Total failed message attempts - messages_retried: Messages that required retry - messages_skipped: Messages skipped due to circuit breaker - circuit_breaker_trips: Number of times circuit opened - rate_limiter_rejections: Messages rejected by rate limiter - avg_publish_time_ms: Average publish latency - last_publish_time: Timestamp of last publish attempt
Requires staff permissions.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
- API Source:
debug_pubsub_metrics_retrieve
1 2 3 4 5 6 7 8 9 10 | |
200 -
| Field | Type | Description |
|---|---|---|
messages_sent |
integer | Total messages successfully sent |
messages_failed |
integer | Total failed message attempts |
messages_retried |
integer | Messages that required retry |
messages_skipped |
integer | Messages skipped due to circuit breaker |
circuit_breaker_trips |
integer | Number of times circuit breaker opened |
rate_limiter_rejections |
integer | Messages rejected by rate limiter |
avg_publish_time_ms |
number (double) | Average message publish latency in milliseconds |
last_publish_time |
number (double) | Unix timestamp of last publish attempt |
Get pubsub system health overview
Dashboard overview of pubsub system health.
Combines circuit breaker state, publishing metrics, and health indicators into a single response suitable for monitoring dashboards.
Requires staff permissions.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
- API Source:
debug_pubsub_overview_retrieve
1 2 3 4 5 6 7 8 9 10 | |
200 -
| Field | Type | Description |
|---|---|---|
health_status |
string | Overall health: healthy, degraded, or critical |
issues |
array of strings | List of current issues affecting health |
circuit_breaker |
any | Circuit breaker summary |
metrics |
any | Publishing metrics summary |
last_updated |
string (date-time) | Timestamp when overview was generated |
Get subscription queues overview
Get overview of subscription queues from RabbitMQ.
Returns summary of subscription queues across all vhosts including message counts and queue statistics.
Note: For detailed queue management, use /api/rabbitmq-stats/ endpoint.
Requires staff permissions.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
- API Source:
debug_pubsub_queues_retrieve
1 2 3 4 5 6 7 8 9 10 | |
200 -
| Field | Type | Description |
|---|---|---|
total_vhosts |
integer | Total number of vhosts with subscription queues |
total_queues |
integer | Total number of subscription queues |
total_messages |
integer | Total messages across all subscription queues |
top_queues_by_messages |
array of objects | Top 10 queues by message count |
top_queues_by_messages.vhost |
string | Virtual host name |
top_queues_by_messages.name |
string | Queue name |
top_queues_by_messages.messages |
integer | Number of messages in queue |
top_queues_by_messages.consumers |
integer | Number of consumers attached |
503 -
| Field | Type | Description |
|---|---|---|
error |
string | Error message describing what went wrong |
Reset circuit breaker
Manually reset the STOMP circuit breaker to CLOSED state.
Use with caution - only when RabbitMQ is confirmed healthy.
Requires staff permissions.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
- API Source:
debug_pubsub_circuit_breaker_reset
1 2 3 4 5 6 7 8 9 10 | |
200 -
| Field | Type | Description |
|---|---|---|
status |
string | Operation status |
state |
string | New circuit breaker state after reset |
Reset publishing metrics
Reset all publishing metrics counters to zero.
Requires staff permissions.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
- API Source:
debug_pubsub_metrics_reset
1 2 3 4 5 6 7 8 9 10 | |
200 -
| Field | Type | Description |
|---|---|---|
status |
string | Operation status |
External Links
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/external-links/ |
List external links |
| GET | /api/external-links/{uuid}/ |
Retrieve external link |
| POST | /api/external-links/ |
Create an external link |
| PUT | /api/external-links/{uuid}/ |
Update an external link |
| PATCH | /api/external-links/{uuid}/ |
Partially update an external link |
| DELETE | /api/external-links/{uuid}/ |
Delete an external link |
List external links
Retrieve a list of external links available in the system.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
external_links_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
o |
string | Which field to use when ordering the results. |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
query |
string | Filter by name, link or description |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
description |
string |
link |
string (uri) |
image |
string (uri) |
created |
string (date-time) |
modified |
string (date-time) |
Retrieve external link
Fetch the details of a specific external link by its UUID.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
external_links_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
description |
string |
link |
string (uri) |
image |
string (uri) |
created |
string (date-time) |
modified |
string (date-time) |
Create an external link
Create a new external link. This action is restricted to staff users.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
ExternalLinkRequest - API Source:
external_links_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Field | Type | Required |
|---|---|---|
name |
string | ✓ |
description |
string | |
link |
string (uri) | ✓ |
image |
string (binary) |
201 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
description |
string |
link |
string (uri) |
image |
string (uri) |
created |
string (date-time) |
modified |
string (date-time) |
Update an external link
Update an existing external link. This action is restricted to staff users.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
ExternalLinkRequest - API Source:
external_links_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
name |
string | ✓ |
description |
string | |
link |
string (uri) | ✓ |
image |
string (binary) |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
description |
string |
link |
string (uri) |
image |
string (uri) |
created |
string (date-time) |
modified |
string (date-time) |
Partially update an external link
Partially update an existing external link. This action is restricted to staff users.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedExternalLinkRequest - API Source:
external_links_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
name |
string | |
description |
string | |
link |
string (uri) | |
image |
string (binary) |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
description |
string |
link |
string (uri) |
image |
string (uri) |
created |
string (date-time) |
modified |
string (date-time) |
Delete an external link
Delete an existing external link. This action is restricted to staff users.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
external_links_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Feature Values
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| POST | /api/feature-values/ |
Update feature flags |
Update feature flags
Allows administrators to enable or disable specific feature flags in the system. The request should be a dictionary where keys are feature sections and values are dictionaries of feature keys and their boolean state.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
- API Source:
feature_values
1 2 3 4 5 6 7 8 9 10 | |
200 -
Media
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/media/{uuid}/ |
Get media file |
Get media file
Get media file
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
media_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string | ✓ |
200 -
Metadata
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/metadata/events/ |
Get event metadata |
| GET | /api/metadata/features/ |
Get feature flag metadata |
| GET | /api/metadata/permissions/ |
Get permission metadata |
| GET | /api/metadata/settings/ |
Get overridable settings metadata |
Get event metadata
Retrieves metadata for all available event types, grouped by categories. This endpoint is publicly accessible and is useful for building UIs for event filtering or webhook configuration.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
- API Source:
metadata_events_retrieve
1 2 3 4 5 6 7 8 9 10 | |
200 -
| Field | Type | Description |
|---|---|---|
event_groups |
object (free-form) | Map of event group keys to lists of event type enums from EventType |
Get feature flag metadata
Retrieves metadata for all available feature flags, including their keys, descriptions, and grouping sections. This endpoint is publicly accessible and helps UIs to dynamically render feature-related settings.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
- API Source:
metadata_features_retrieve
1 2 3 4 5 6 7 8 9 10 | |
200 -
| Field | Type | Description |
|---|---|---|
features |
array of objects | List of feature sections with descriptions |
feature_enums |
object (free-form) | Nested feature enum values by section |
Get permission metadata
Retrieves metadata about roles, permissions, and their descriptions. This endpoint is publicly accessible and provides data needed for UI components, such as role selection dropdowns and permission management interfaces.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
- API Source:
metadata_permissions_retrieve
1 2 3 4 5 6 7 8 9 10 | |
200 -
| Field | Type | Description |
|---|---|---|
roles |
object (free-form) | Map of role keys to role enum values from RoleEnum |
permissions |
object (free-form) | Map of permission keys to permission enum values from PermissionEnum |
permission_map |
object (free-form) | Map of resource types to create permission enums |
permission_descriptions |
array of objects | Grouped permission descriptions for UI |
Get overridable settings metadata
Retrieves metadata for all settings that can be configured via the Constance backend. This includes setting keys, human-readable descriptions, default values, and types. This endpoint is publicly accessible.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
- API Source:
metadata_settings_retrieve
1 2 3 4 5 6 7 8 9 10 | |
200 -
| Field | Type | Description |
|---|---|---|
settings |
array of objects | List of settings sections with configuration items |
Override Settings
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/override-settings/ |
Get all overridable settings |
| Other Actions | ||
| POST | /api/override-settings/ |
Update overridable settings |
Core CRUD
Get all overridable settings
Returns all settings that can be overridden in the database via the Constance backend. Requires admin permissions.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
- API Source:
override_settings_retrieve
1 2 3 4 5 6 7 8 9 10 | |
200 -
| Field | Type |
|---|---|
SITE_NAME |
string |
SITE_DESCRIPTION |
string |
HOMEPORT_URL |
string |
RANCHER_USERNAME_INPUT_LABEL |
string |
DISCLAIMER_AREA_TEXT |
string |
SITE_ADDRESS |
string |
SITE_EMAIL |
string |
SITE_PHONE |
string |
CURRENCY_NAME |
string |
THUMBNAIL_SIZE |
string |
ANONYMOUS_USER_CAN_VIEW_OFFERINGS |
boolean |
ANONYMOUS_USER_CAN_VIEW_PLANS |
boolean |
RESTRICTED_OFFERING_VISIBILITY_MODE |
string |
ALLOW_SERVICE_PROVIDER_OFFERING_MANAGEMENT |
boolean |
NOTIFY_STAFF_ABOUT_APPROVALS |
boolean |
NOTIFY_ABOUT_RESOURCE_CHANGE |
boolean |
DISABLE_SENDING_NOTIFICATIONS_ABOUT_RESOURCE_UPDATE |
boolean |
MARKETPLACE_LANDING_PAGE |
string |
ENABLE_STALE_RESOURCE_NOTIFICATIONS |
boolean |
TELEMETRY_URL |
string |
TELEMETRY_VERSION |
integer |
SCRIPT_RUN_MODE |
string |
DOCKER_CLIENT |
string |
DOCKER_RUN_OPTIONS |
string |
DOCKER_SCRIPT_DIR |
string |
DOCKER_REMOVE_CONTAINER |
boolean |
DOCKER_IMAGES |
string |
DOCKER_VOLUME_NAME |
string |
K8S_NAMESPACE |
string |
K8S_CONFIG_PATH |
string |
K8S_JOB_TIMEOUT |
integer |
ENABLE_STRICT_CHECK_ACCEPTING_INVITATION |
boolean |
INVITATION_DISABLE_MULTIPLE_ROLES |
boolean |
DEFAULT_IDP |
any |
DOCS_URL |
string (uri) |
SHORT_PAGE_TITLE |
string |
FULL_PAGE_TITLE |
string |
PROJECT_END_DATE_MANDATORY |
boolean |
ENABLE_ORDER_START_DATE |
boolean |
BRAND_COLOR |
string |
HERO_LINK_LABEL |
string |
HERO_LINK_URL |
string (uri) |
SUPPORT_PORTAL_URL |
string (uri) |
COMMON_FOOTER_TEXT |
string |
COMMON_FOOTER_HTML |
string |
LANGUAGE_CHOICES |
string |
DISABLE_DARK_THEME |
boolean |
POWERED_BY_LOGO |
string (uri) |
HERO_IMAGE |
string (uri) |
MARKETPLACE_HERO_IMAGE |
string (uri) |
CALL_MANAGEMENT_HERO_IMAGE |
string (uri) |
SIDEBAR_LOGO |
string (uri) |
SIDEBAR_LOGO_DARK |
string (uri) |
SIDEBAR_LOGO_MOBILE |
string (uri) |
SIDEBAR_STYLE |
string |
FONT_FAMILY |
string |
LOGIN_LOGO |
string (uri) |
LOGIN_LOGO_MULTILINGUAL |
object (free-form) |
LOGIN_PAGE_LAYOUT |
string |
LOGIN_PAGE_VIDEO_URL |
string (uri) |
LOGIN_PAGE_STATS |
array of anys |
LOGIN_PAGE_CAROUSEL_SLIDES |
array of anys |
LOGIN_PAGE_NEWS |
array of anys |
FAVICON |
string (uri) |
OFFERING_LOGO_PLACEHOLDER |
string (uri) |
DISCLAIMER_AREA_LOGO |
string (uri) |
WALDUR_SUPPORT_ENABLED |
boolean |
WALDUR_SUPPORT_ACTIVE_BACKEND_TYPE |
string |
WALDUR_SUPPORT_DISPLAY_REQUEST_TYPE |
boolean |
ATLASSIAN_MAP_WALDUR_USERS_TO_SERVICEDESK_AGENTS |
boolean |
ATLASSIAN_API_URL |
string (uri) |
ATLASSIAN_USERNAME |
string |
ATLASSIAN_PASSWORD |
string |
ATLASSIAN_EMAIL |
string (email) |
ATLASSIAN_USE_OLD_API |
boolean |
ATLASSIAN_TOKEN |
string |
ATLASSIAN_PERSONAL_ACCESS_TOKEN |
string |
ATLASSIAN_OAUTH2_CLIENT_ID |
string |
ATLASSIAN_OAUTH2_ACCESS_TOKEN |
string |
ATLASSIAN_OAUTH2_TOKEN_TYPE |
string |
ATLASSIAN_VERIFY_SSL |
boolean |
ATLASSIAN_PROJECT_ID |
string |
ATLASSIAN_SHARED_USERNAME |
boolean |
ATLASSIAN_CUSTOM_ISSUE_FIELD_MAPPING_ENABLED |
boolean |
ATLASSIAN_DEFAULT_OFFERING_ISSUE_TYPE |
string |
ATLASSIAN_EXCLUDED_ATTACHMENT_TYPES |
string |
ATLASSIAN_DESCRIPTION_TEMPLATE |
string |
ATLASSIAN_SUMMARY_TEMPLATE |
string |
ATLASSIAN_AFFECTED_RESOURCE_FIELD |
string |
ATLASSIAN_IMPACT_FIELD |
string |
ATLASSIAN_ORGANISATION_FIELD |
string |
ATLASSIAN_RESOLUTION_SLA_FIELD |
string |
ATLASSIAN_PROJECT_FIELD |
string |
ATLASSIAN_REPORTER_FIELD |
string |
ATLASSIAN_CALLER_FIELD |
string |
ATLASSIAN_SLA_FIELD |
string |
ATLASSIAN_LINKED_ISSUE_TYPE |
string |
ATLASSIAN_SATISFACTION_FIELD |
string |
ATLASSIAN_REQUEST_FEEDBACK_FIELD |
string |
ATLASSIAN_TEMPLATE_FIELD |
string |
ATLASSIAN_WALDUR_BACKEND_ID_FIELD |
string |
ZAMMAD_API_URL |
string (uri) |
ZAMMAD_TOKEN |
string |
ZAMMAD_GROUP |
string |
ZAMMAD_ARTICLE_TYPE |
string |
ZAMMAD_COMMENT_MARKER |
string |
ZAMMAD_COMMENT_PREFIX |
string |
ZAMMAD_COMMENT_COOLDOWN_DURATION |
integer |
SMAX_API_URL |
string (uri) |
SMAX_TENANT_ID |
string |
SMAX_LOGIN |
string |
SMAX_PASSWORD |
string |
SMAX_ORGANISATION_FIELD |
string |
SMAX_PROJECT_FIELD |
string |
SMAX_AFFECTED_RESOURCE_FIELD |
string |
SMAX_TIMES_TO_PULL |
integer |
SMAX_SECONDS_TO_WAIT |
integer |
SMAX_CREATION_SOURCE_NAME |
string |
SMAX_REQUESTS_OFFERING |
string |
SMAX_VERIFY_SSL |
boolean |
ENABLE_MOCK_SERVICE_ACCOUNT_BACKEND |
boolean |
ENABLE_MOCK_COURSE_ACCOUNT_BACKEND |
boolean |
PROPOSAL_REVIEW_DURATION |
integer |
ORCID_CLIENT_ID |
string |
ORCID_CLIENT_SECRET |
string |
ORCID_REDIRECT_URI |
string (uri) |
ORCID_API_URL |
string (uri) |
ORCID_AUTH_URL |
string (uri) |
ORCID_SANDBOX_MODE |
boolean |
SEMANTIC_SCHOLAR_API_KEY |
string |
CROSSREF_MAILTO |
string (email) |
REVIEWER_PROFILES_ENABLED |
boolean |
COI_DETECTION_ENABLED |
boolean |
COI_DISCLOSURE_REQUIRED |
boolean |
AUTOMATED_MATCHING_ENABLED |
boolean |
COI_COAUTHORSHIP_LOOKBACK_YEARS |
integer |
COI_COAUTHORSHIP_THRESHOLD_PAPERS |
integer |
COI_INSTITUTIONAL_LOOKBACK_YEARS |
integer |
USER_TABLE_COLUMNS |
string |
AUTO_APPROVE_USER_TOS |
boolean |
FREEIPA_ENABLED |
boolean |
FREEIPA_HOSTNAME |
string |
FREEIPA_USERNAME |
string |
FREEIPA_PASSWORD |
string |
FREEIPA_VERIFY_SSL |
boolean |
FREEIPA_USERNAME_PREFIX |
string |
FREEIPA_GROUPNAME_PREFIX |
string |
FREEIPA_BLACKLISTED_USERNAMES |
array of strings |
FREEIPA_GROUP_SYNCHRONIZATION_ENABLED |
boolean |
SCIM_MEMBERSHIP_SYNC_ENABLED |
boolean |
SCIM_API_URL |
string |
SCIM_API_KEY |
string |
SCIM_URN_NAMESPACE |
string |
KEYCLOAK_ICON |
string (uri) |
COUNTRIES |
array of strings |
OIDC_AUTH_URL |
string |
OIDC_INTROSPECTION_URL |
string |
OIDC_CLIENT_ID |
string |
OIDC_CLIENT_SECRET |
string |
OIDC_USER_FIELD |
string |
OIDC_CACHE_TIMEOUT |
integer |
OIDC_ACCESS_TOKEN_ENABLED |
boolean |
OIDC_BLOCK_CREATION_OF_UNINVITED_USERS |
boolean |
OIDC_MATCHMAKING_BY_EMAIL |
boolean |
DEACTIVATE_USER_IF_NO_ROLES |
boolean |
WALDUR_AUTH_SOCIAL_ROLE_CLAIM |
string |
REMOTE_EDUTEAMS_REFRESH_TOKEN |
string |
DEFAULT_OFFERING_USER_ATTRIBUTES |
array of anys |
INVITATION_ALLOWED_FIELDS |
array of anys |
ENABLED_USER_PROFILE_ATTRIBUTES |
array of anys |
MANDATORY_USER_ATTRIBUTES |
array of anys |
ENFORCE_MANDATORY_USER_ATTRIBUTES |
boolean |
MAINTENANCE_ANNOUNCEMENT_NOTIFY_BEFORE_MINUTES |
integer |
MAINTENANCE_ANNOUNCEMENT_NOTIFY_SYSTEM |
array of anys |
ENFORCE_USER_CONSENT_FOR_OFFERINGS |
boolean |
ENFORCE_OFFERING_USER_PROFILE_COMPLETENESS |
boolean |
DISABLED_OFFERING_TYPES |
array of anys |
ONBOARDING_VALIDATION_METHODS |
array of anys |
ONBOARDING_VERIFICATION_EXPIRY_HOURS |
integer |
ONBOARDING_ARIREGISTER_BASE_URL |
string (uri) |
ONBOARDING_ARIREGISTER_USERNAME |
string |
ONBOARDING_ARIREGISTER_PASSWORD |
string |
ONBOARDING_ARIREGISTER_TIMEOUT |
integer |
ONBOARDING_WICO_API_URL |
string (uri) |
ONBOARDING_WICO_TOKEN |
string |
ONBOARDING_BOLAGSVERKET_API_URL |
string (uri) |
ONBOARDING_BOLAGSVERKET_TOKEN_API_URL |
string (uri) |
ONBOARDING_BOLAGSVERKET_CLIENT_ID |
string |
ONBOARDING_BOLAGSVERKET_CLIENT_SECRET |
string |
ONBOARDING_BREG_API_URL |
string (uri) |
LLM_CHAT_ENABLED |
boolean |
LLM_INFERENCES_BACKEND_TYPE |
string |
LLM_INFERENCES_API_URL |
string (uri) |
LLM_INFERENCES_API_TOKEN |
string |
LLM_INFERENCES_MODEL |
string |
LLM_TOKEN_LIMIT_DAILY |
integer |
LLM_TOKEN_LIMIT_WEEKLY |
integer |
LLM_TOKEN_LIMIT_MONTHLY |
integer |
LLM_CHAT_SESSION_RETENTION_DAYS |
integer |
LLM_CHAT_HISTORY_LIMIT |
integer |
LLM_INJECTION_ALLOWLIST |
string |
SOFTWARE_CATALOG_EESSI_UPDATE_ENABLED |
boolean |
SOFTWARE_CATALOG_EESSI_VERSION |
string |
SOFTWARE_CATALOG_EESSI_API_URL |
string |
SOFTWARE_CATALOG_EESSI_INCLUDE_EXTENSIONS |
boolean |
SOFTWARE_CATALOG_SPACK_UPDATE_ENABLED |
boolean |
SOFTWARE_CATALOG_SPACK_VERSION |
string |
SOFTWARE_CATALOG_SPACK_DATA_URL |
string |
SOFTWARE_CATALOG_UPDATE_EXISTING_PACKAGES |
boolean |
SOFTWARE_CATALOG_CLEANUP_ENABLED |
boolean |
SOFTWARE_CATALOG_RETENTION_DAYS |
integer |
SYSTEM_LOG_ENABLED |
boolean |
SYSTEM_LOG_MAX_ROWS_PER_SOURCE |
integer |
TABLE_GROWTH_MONITORING_ENABLED |
boolean |
TABLE_GROWTH_WEEKLY_THRESHOLD_PERCENT |
integer |
TABLE_GROWTH_MONTHLY_THRESHOLD_PERCENT |
integer |
TABLE_GROWTH_RETENTION_DAYS |
integer |
TABLE_GROWTH_MIN_SIZE_BYTES |
integer |
USER_ACTIONS_ENABLED |
boolean |
USER_ACTIONS_PENDING_ORDER_HOURS |
integer |
USER_ACTIONS_HIGH_URGENCY_NOTIFICATION |
boolean |
USER_ACTIONS_NOTIFICATION_THRESHOLD |
integer |
USER_ACTIONS_EXECUTION_RETENTION_DAYS |
integer |
USER_ACTIONS_DEFAULT_EXPIRATION_REMINDERS |
array of strings |
USER_DATA_ACCESS_LOGGING_ENABLED |
boolean |
USER_DATA_ACCESS_LOG_RETENTION_DAYS |
integer |
USER_DATA_ACCESS_LOG_SELF_ACCESS |
boolean |
ARROW_AUTO_RECONCILIATION |
boolean |
ARROW_SYNC_INTERVAL_HOURS |
integer |
ARROW_CONSUMPTION_SYNC_ENABLED |
boolean |
ARROW_CONSUMPTION_SYNC_INTERVAL_HOURS |
integer |
ARROW_BILLING_CHECK_INTERVAL_HOURS |
integer |
SLURM_POLICY_EVALUATION_LOG_RETENTION_DAYS |
integer |
FEDERATED_IDENTITY_SYNC_ENABLED |
boolean |
FEDERATED_IDENTITY_SYNC_ALLOWED_ATTRIBUTES |
array of anys |
FEDERATED_IDENTITY_DEACTIVATION_POLICY |
string |
ENABLE_PROJECT_DIGEST |
boolean |
Other Actions
Update overridable settings
Updates one or more settings in the database via the Constance backend. Requires admin permissions.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
- Model Source:
ConstanceSettingsRequest - API Source:
override_settings
1 2 3 4 5 6 7 8 9 10 | |
| Field | Type | Required |
|---|---|---|
SITE_NAME |
string | |
SITE_DESCRIPTION |
string | |
HOMEPORT_URL |
string | |
RANCHER_USERNAME_INPUT_LABEL |
string | |
DISCLAIMER_AREA_TEXT |
string | |
SITE_ADDRESS |
string | |
SITE_EMAIL |
string | |
SITE_PHONE |
string | |
CURRENCY_NAME |
string | |
THUMBNAIL_SIZE |
string | |
ANONYMOUS_USER_CAN_VIEW_OFFERINGS |
boolean | |
ANONYMOUS_USER_CAN_VIEW_PLANS |
boolean | |
RESTRICTED_OFFERING_VISIBILITY_MODE |
string | |
ALLOW_SERVICE_PROVIDER_OFFERING_MANAGEMENT |
boolean | |
NOTIFY_STAFF_ABOUT_APPROVALS |
boolean | |
NOTIFY_ABOUT_RESOURCE_CHANGE |
boolean | |
DISABLE_SENDING_NOTIFICATIONS_ABOUT_RESOURCE_UPDATE |
boolean | |
MARKETPLACE_LANDING_PAGE |
string | |
ENABLE_STALE_RESOURCE_NOTIFICATIONS |
boolean | |
TELEMETRY_URL |
string | |
TELEMETRY_VERSION |
integer | |
SCRIPT_RUN_MODE |
string | |
DOCKER_CLIENT |
string | |
DOCKER_RUN_OPTIONS |
string | |
DOCKER_SCRIPT_DIR |
string | |
DOCKER_REMOVE_CONTAINER |
boolean | |
DOCKER_IMAGES |
string | |
DOCKER_VOLUME_NAME |
string | |
K8S_NAMESPACE |
string | |
K8S_CONFIG_PATH |
string | |
K8S_JOB_TIMEOUT |
integer | |
ENABLE_STRICT_CHECK_ACCEPTING_INVITATION |
boolean | |
INVITATION_DISABLE_MULTIPLE_ROLES |
boolean | |
DEFAULT_IDP |
any | |
DOCS_URL |
string (uri) | |
SHORT_PAGE_TITLE |
string | |
FULL_PAGE_TITLE |
string | |
PROJECT_END_DATE_MANDATORY |
boolean | |
ENABLE_ORDER_START_DATE |
boolean | |
BRAND_COLOR |
string | |
HERO_LINK_LABEL |
string | |
HERO_LINK_URL |
string (uri) | |
SUPPORT_PORTAL_URL |
string (uri) | |
COMMON_FOOTER_TEXT |
string | |
COMMON_FOOTER_HTML |
string | |
LANGUAGE_CHOICES |
string | |
DISABLE_DARK_THEME |
boolean | |
POWERED_BY_LOGO |
string (binary) | |
HERO_IMAGE |
string (binary) | |
MARKETPLACE_HERO_IMAGE |
string (binary) | |
CALL_MANAGEMENT_HERO_IMAGE |
string (binary) | |
SIDEBAR_LOGO |
string (binary) | |
SIDEBAR_LOGO_DARK |
string (binary) | |
SIDEBAR_LOGO_MOBILE |
string (binary) | |
SIDEBAR_STYLE |
string | |
FONT_FAMILY |
string | |
LOGIN_LOGO |
string (binary) | |
LOGIN_LOGO_MULTILINGUAL |
object (free-form) | |
LOGIN_PAGE_LAYOUT |
string | |
LOGIN_PAGE_VIDEO_URL |
string (uri) | |
LOGIN_PAGE_STATS |
array of anys | |
LOGIN_PAGE_CAROUSEL_SLIDES |
array of anys | |
LOGIN_PAGE_NEWS |
array of anys | |
FAVICON |
string (binary) | |
OFFERING_LOGO_PLACEHOLDER |
string (binary) | |
DISCLAIMER_AREA_LOGO |
string (binary) | |
WALDUR_SUPPORT_ENABLED |
boolean | |
WALDUR_SUPPORT_ACTIVE_BACKEND_TYPE |
string | |
WALDUR_SUPPORT_DISPLAY_REQUEST_TYPE |
boolean | |
ATLASSIAN_MAP_WALDUR_USERS_TO_SERVICEDESK_AGENTS |
boolean | |
ATLASSIAN_API_URL |
string (uri) | |
ATLASSIAN_USERNAME |
string | |
ATLASSIAN_PASSWORD |
string | |
ATLASSIAN_EMAIL |
string (email) | |
ATLASSIAN_USE_OLD_API |
boolean | |
ATLASSIAN_TOKEN |
string | |
ATLASSIAN_PERSONAL_ACCESS_TOKEN |
string | |
ATLASSIAN_OAUTH2_CLIENT_ID |
string | |
ATLASSIAN_OAUTH2_ACCESS_TOKEN |
string | |
ATLASSIAN_OAUTH2_TOKEN_TYPE |
string | |
ATLASSIAN_VERIFY_SSL |
boolean | |
ATLASSIAN_PROJECT_ID |
string | |
ATLASSIAN_SHARED_USERNAME |
boolean | |
ATLASSIAN_CUSTOM_ISSUE_FIELD_MAPPING_ENABLED |
boolean | |
ATLASSIAN_DEFAULT_OFFERING_ISSUE_TYPE |
string | |
ATLASSIAN_EXCLUDED_ATTACHMENT_TYPES |
string | |
ATLASSIAN_DESCRIPTION_TEMPLATE |
string | |
ATLASSIAN_SUMMARY_TEMPLATE |
string | |
ATLASSIAN_AFFECTED_RESOURCE_FIELD |
string | |
ATLASSIAN_IMPACT_FIELD |
string | |
ATLASSIAN_ORGANISATION_FIELD |
string | |
ATLASSIAN_RESOLUTION_SLA_FIELD |
string | |
ATLASSIAN_PROJECT_FIELD |
string | |
ATLASSIAN_REPORTER_FIELD |
string | |
ATLASSIAN_CALLER_FIELD |
string | |
ATLASSIAN_SLA_FIELD |
string | |
ATLASSIAN_LINKED_ISSUE_TYPE |
string | |
ATLASSIAN_SATISFACTION_FIELD |
string | |
ATLASSIAN_REQUEST_FEEDBACK_FIELD |
string | |
ATLASSIAN_TEMPLATE_FIELD |
string | |
ATLASSIAN_WALDUR_BACKEND_ID_FIELD |
string | |
ZAMMAD_API_URL |
string (uri) | |
ZAMMAD_TOKEN |
string | |
ZAMMAD_GROUP |
string | |
ZAMMAD_ARTICLE_TYPE |
string | |
ZAMMAD_COMMENT_MARKER |
string | |
ZAMMAD_COMMENT_PREFIX |
string | |
ZAMMAD_COMMENT_COOLDOWN_DURATION |
integer | |
SMAX_API_URL |
string (uri) | |
SMAX_TENANT_ID |
string | |
SMAX_LOGIN |
string | |
SMAX_PASSWORD |
string | |
SMAX_ORGANISATION_FIELD |
string | |
SMAX_PROJECT_FIELD |
string | |
SMAX_AFFECTED_RESOURCE_FIELD |
string | |
SMAX_TIMES_TO_PULL |
integer | |
SMAX_SECONDS_TO_WAIT |
integer | |
SMAX_CREATION_SOURCE_NAME |
string | |
SMAX_REQUESTS_OFFERING |
string | |
SMAX_VERIFY_SSL |
boolean | |
ENABLE_MOCK_SERVICE_ACCOUNT_BACKEND |
boolean | |
ENABLE_MOCK_COURSE_ACCOUNT_BACKEND |
boolean | |
PROPOSAL_REVIEW_DURATION |
integer | |
ORCID_CLIENT_ID |
string | |
ORCID_CLIENT_SECRET |
string | |
ORCID_REDIRECT_URI |
string (uri) | |
ORCID_API_URL |
string (uri) | |
ORCID_AUTH_URL |
string (uri) | |
ORCID_SANDBOX_MODE |
boolean | |
SEMANTIC_SCHOLAR_API_KEY |
string | |
CROSSREF_MAILTO |
string (email) | |
REVIEWER_PROFILES_ENABLED |
boolean | |
COI_DETECTION_ENABLED |
boolean | |
COI_DISCLOSURE_REQUIRED |
boolean | |
AUTOMATED_MATCHING_ENABLED |
boolean | |
COI_COAUTHORSHIP_LOOKBACK_YEARS |
integer | |
COI_COAUTHORSHIP_THRESHOLD_PAPERS |
integer | |
COI_INSTITUTIONAL_LOOKBACK_YEARS |
integer | |
USER_TABLE_COLUMNS |
string | |
AUTO_APPROVE_USER_TOS |
boolean | |
FREEIPA_ENABLED |
boolean | |
FREEIPA_HOSTNAME |
string | |
FREEIPA_USERNAME |
string | |
FREEIPA_PASSWORD |
string | |
FREEIPA_VERIFY_SSL |
boolean | |
FREEIPA_USERNAME_PREFIX |
string | |
FREEIPA_GROUPNAME_PREFIX |
string | |
FREEIPA_BLACKLISTED_USERNAMES |
array of strings | |
FREEIPA_GROUP_SYNCHRONIZATION_ENABLED |
boolean | |
SCIM_MEMBERSHIP_SYNC_ENABLED |
boolean | |
SCIM_API_URL |
string | |
SCIM_API_KEY |
string | |
SCIM_URN_NAMESPACE |
string | |
KEYCLOAK_ICON |
string (binary) | |
COUNTRIES |
array of strings | |
OIDC_AUTH_URL |
string | |
OIDC_INTROSPECTION_URL |
string | |
OIDC_CLIENT_ID |
string | |
OIDC_CLIENT_SECRET |
string | |
OIDC_USER_FIELD |
string | |
OIDC_CACHE_TIMEOUT |
integer | |
OIDC_ACCESS_TOKEN_ENABLED |
boolean | |
OIDC_BLOCK_CREATION_OF_UNINVITED_USERS |
boolean | |
OIDC_MATCHMAKING_BY_EMAIL |
boolean | |
DEACTIVATE_USER_IF_NO_ROLES |
boolean | |
WALDUR_AUTH_SOCIAL_ROLE_CLAIM |
string | |
REMOTE_EDUTEAMS_REFRESH_TOKEN |
string | |
DEFAULT_OFFERING_USER_ATTRIBUTES |
array of anys | |
INVITATION_ALLOWED_FIELDS |
array of anys | |
ENABLED_USER_PROFILE_ATTRIBUTES |
array of anys | |
MANDATORY_USER_ATTRIBUTES |
array of anys | |
ENFORCE_MANDATORY_USER_ATTRIBUTES |
boolean | |
MAINTENANCE_ANNOUNCEMENT_NOTIFY_BEFORE_MINUTES |
integer | |
MAINTENANCE_ANNOUNCEMENT_NOTIFY_SYSTEM |
array of anys | |
ENFORCE_USER_CONSENT_FOR_OFFERINGS |
boolean | |
ENFORCE_OFFERING_USER_PROFILE_COMPLETENESS |
boolean | |
DISABLED_OFFERING_TYPES |
array of anys | |
ONBOARDING_VALIDATION_METHODS |
array of anys | |
ONBOARDING_VERIFICATION_EXPIRY_HOURS |
integer | |
ONBOARDING_ARIREGISTER_BASE_URL |
string (uri) | |
ONBOARDING_ARIREGISTER_USERNAME |
string | |
ONBOARDING_ARIREGISTER_PASSWORD |
string | |
ONBOARDING_ARIREGISTER_TIMEOUT |
integer | |
ONBOARDING_WICO_API_URL |
string (uri) | |
ONBOARDING_WICO_TOKEN |
string | |
ONBOARDING_BOLAGSVERKET_API_URL |
string (uri) | |
ONBOARDING_BOLAGSVERKET_TOKEN_API_URL |
string (uri) | |
ONBOARDING_BOLAGSVERKET_CLIENT_ID |
string | |
ONBOARDING_BOLAGSVERKET_CLIENT_SECRET |
string | |
ONBOARDING_BREG_API_URL |
string (uri) | |
LLM_CHAT_ENABLED |
boolean | |
LLM_INFERENCES_BACKEND_TYPE |
string | |
LLM_INFERENCES_API_URL |
string (uri) | |
LLM_INFERENCES_API_TOKEN |
string | |
LLM_INFERENCES_MODEL |
string | |
LLM_TOKEN_LIMIT_DAILY |
integer | |
LLM_TOKEN_LIMIT_WEEKLY |
integer | |
LLM_TOKEN_LIMIT_MONTHLY |
integer | |
LLM_CHAT_SESSION_RETENTION_DAYS |
integer | |
LLM_CHAT_HISTORY_LIMIT |
integer | |
LLM_INJECTION_ALLOWLIST |
string | |
SOFTWARE_CATALOG_EESSI_UPDATE_ENABLED |
boolean | |
SOFTWARE_CATALOG_EESSI_VERSION |
string | |
SOFTWARE_CATALOG_EESSI_API_URL |
string | |
SOFTWARE_CATALOG_EESSI_INCLUDE_EXTENSIONS |
boolean | |
SOFTWARE_CATALOG_SPACK_UPDATE_ENABLED |
boolean | |
SOFTWARE_CATALOG_SPACK_VERSION |
string | |
SOFTWARE_CATALOG_SPACK_DATA_URL |
string | |
SOFTWARE_CATALOG_UPDATE_EXISTING_PACKAGES |
boolean | |
SOFTWARE_CATALOG_CLEANUP_ENABLED |
boolean | |
SOFTWARE_CATALOG_RETENTION_DAYS |
integer | |
SYSTEM_LOG_ENABLED |
boolean | |
SYSTEM_LOG_MAX_ROWS_PER_SOURCE |
integer | |
TABLE_GROWTH_MONITORING_ENABLED |
boolean | |
TABLE_GROWTH_WEEKLY_THRESHOLD_PERCENT |
integer | |
TABLE_GROWTH_MONTHLY_THRESHOLD_PERCENT |
integer | |
TABLE_GROWTH_RETENTION_DAYS |
integer | |
TABLE_GROWTH_MIN_SIZE_BYTES |
integer | |
USER_ACTIONS_ENABLED |
boolean | |
USER_ACTIONS_PENDING_ORDER_HOURS |
integer | |
USER_ACTIONS_HIGH_URGENCY_NOTIFICATION |
boolean | |
USER_ACTIONS_NOTIFICATION_THRESHOLD |
integer | |
USER_ACTIONS_EXECUTION_RETENTION_DAYS |
integer | |
USER_ACTIONS_DEFAULT_EXPIRATION_REMINDERS |
array of strings | |
USER_DATA_ACCESS_LOGGING_ENABLED |
boolean | |
USER_DATA_ACCESS_LOG_RETENTION_DAYS |
integer | |
USER_DATA_ACCESS_LOG_SELF_ACCESS |
boolean | |
ARROW_AUTO_RECONCILIATION |
boolean | |
ARROW_SYNC_INTERVAL_HOURS |
integer | |
ARROW_CONSUMPTION_SYNC_ENABLED |
boolean | |
ARROW_CONSUMPTION_SYNC_INTERVAL_HOURS |
integer | |
ARROW_BILLING_CHECK_INTERVAL_HOURS |
integer | |
SLURM_POLICY_EVALUATION_LOG_RETENTION_DAYS |
integer | |
FEDERATED_IDENTITY_SYNC_ENABLED |
boolean | |
FEDERATED_IDENTITY_SYNC_ALLOWED_ATTRIBUTES |
array of anys | |
FEDERATED_IDENTITY_DEACTIVATION_POLICY |
string | |
ENABLE_PROJECT_DIGEST |
boolean |
200 - No response body
Query
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| POST | /api/query/ |
Execute read-only SQL query |
Execute read-only SQL query
Execute a given SQL query against a read-only database replica. This is a powerful tool for diagnostics and reporting, but should be used with caution. Requires support user permissions.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
QueryRequest - API Source:
query
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Field | Type | Required | Description |
|---|---|---|---|
query |
string | ✓ | Search query string |
200 -
400 - No response body
Stats
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/stats/celery/ |
Get Celery worker statistics |
| GET | /api/stats/database/ |
Get comprehensive database statistics |
| GET | /api/stats/table-growth/ |
Get table growth statistics |
| POST | /api/stats/query/ |
Execute read-only SQL query |
Get Celery worker statistics
Provides a comprehensive snapshot of all Celery workers' status.
This endpoint returns detailed information about: - active: Tasks currently being executed by workers - scheduled: Tasks scheduled for future execution (with ETA) - reserved: Tasks received by workers but not yet started - revoked: Task IDs that have been cancelled/revoked - query_task: Results of task queries (if any) - stats: Detailed worker statistics including uptime, pool info, and broker connection
Each field is a dictionary where keys are worker names (e.g., 'celery@hostname').
If no workers are available, fields will be null.
Requires support user permissions.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
- API Source:
stats_celery_retrieve
1 2 3 4 5 6 7 8 9 10 | |
200 -
| Field | Type | Description |
|---|---|---|
active |
object (free-form) | Currently executing tasks per worker. Keys are worker names, values are lists of active tasks. |
scheduled |
object (free-form) | Tasks scheduled for future execution per worker. Keys are worker names, values are lists of scheduled tasks with ETA. |
reserved |
object (free-form) | Tasks that have been received but not yet started per worker. Keys are worker names, values are lists of reserved tasks. |
revoked |
object (free-form) | IDs of revoked (cancelled) tasks per worker. Keys are worker names, values are lists of task IDs. |
query_task |
object (free-form) | Query results for specific tasks. May be null if no query was performed. |
stats |
object (free-form) | Detailed statistics per worker including uptime, pool info, and resource usage. Keys are worker names. |
Get comprehensive database statistics
Retrieves comprehensive statistics about the PostgreSQL database including: - Table statistics: Top 10 largest tables by size - Connection statistics: Active, idle, and waiting connections with utilization - Database size: Total size, data size, and index size - Cache performance: Buffer cache and index hit ratios (should be >99%) - Transaction statistics: Commits, rollbacks, deadlocks - Lock statistics: Current locks and waiting queries - Maintenance statistics: Dead tuples, vacuum needs, oldest transaction age - Active queries: Currently running queries with duration - Query performance: Sequential vs index scan ratios - Replication status: WAL size and replication lag (if applicable)
This information is useful for monitoring, debugging, and performance tuning. Requires support user permissions.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
- API Source:
stats_database_retrieve
1 2 3 4 5 6 7 8 9 10 | |
200 -
| Field | Type | Description |
|---|---|---|
table_stats |
array of objects | Top largest tables by size |
table_stats.table_name |
string | Name of the database table |
table_stats.total_size |
integer | Total size of the table in bytes |
table_stats.data_size |
integer | Size of the actual data in bytes |
table_stats.external_size |
integer | Size of external data (e.g., TOAST) in bytes |
connections |
any | Connection statistics |
database_size |
any | Database size information |
cache_performance |
any | Cache hit ratios and memory settings |
transactions |
any | Transaction commit/rollback statistics |
locks |
any | Current lock statistics |
maintenance |
any | Vacuum and maintenance statistics |
active_queries |
any | Currently running queries |
query_performance |
any | Query performance indicators |
replication |
any | Replication status (if applicable) |
Get table growth statistics
Retrieves historical table growth statistics for detecting abnormal patterns.
This endpoint returns: - date: Current date of the statistics - weekly_threshold_percent: Configured alert threshold for weekly growth - monthly_threshold_percent: Configured alert threshold for monthly growth - tables: List of tables with their growth statistics, sorted by growth rate
Each table entry includes: - Current size and row estimates - Size and row estimates from 7 days ago - Size and row estimates from 30 days ago - Weekly and monthly growth percentages
Use this data to identify tables that may be experiencing abnormal growth, which could indicate bugs like the version-based get_or_create issue.
Query parameters: - table_name (optional): Filter to a specific table name - days (optional, default 30): Number of days of history to include
Requires support user permissions.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
- API Source:
stats_table_growth_retrieve
1 2 3 4 5 6 7 8 9 10 | |
200 -
| Field | Type | Description |
|---|---|---|
date |
string (date) | Current date of the statistics |
weekly_threshold_percent |
integer | Configured weekly growth alert threshold |
monthly_threshold_percent |
integer | Configured monthly growth alert threshold |
tables |
array of objects | Table growth statistics sorted by growth rate |
tables.table_name |
string | Name of the database table |
tables.current_total_size |
integer | Current total size including indexes in bytes |
tables.current_data_size |
integer | Current data-only size in bytes |
tables.current_row_estimate |
integer | Current estimated row count |
tables.week_ago_total_size |
integer | Total size from 7 days ago in bytes |
tables.week_ago_row_estimate |
integer | Row estimate from 7 days ago |
tables.month_ago_total_size |
integer | Total size from 30 days ago in bytes |
tables.month_ago_row_estimate |
integer | Row estimate from 30 days ago |
tables.weekly_growth_percent |
number (double) | Percentage growth over the past week |
tables.monthly_growth_percent |
number (double) | Percentage growth over the past month |
tables.weekly_row_growth_percent |
number (double) | Percentage row count growth over the past week |
tables.monthly_row_growth_percent |
number (double) | Percentage row count growth over the past month |
alerts |
array of objects | List of tables that exceeded configured growth thresholds |
alerts.table_name |
string | Name of the table triggering the alert |
alerts.period |
any | Growth period that exceeded the threshold |
alerts.growth_percent |
number (double) | Actual growth percentage observed |
alerts.threshold |
integer | Configured threshold that was exceeded |
Execute read-only SQL query
Execute a given SQL query against a read-only database replica. This is a powerful tool for diagnostics and reporting, but should be used with caution. Requires support user permissions.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
QueryRequest - API Source:
stats_query
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Field | Type | Required | Description |
|---|---|---|---|
query |
string | ✓ | Search query string |
200 -
400 - No response body
User Agreements
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/user-agreements/ |
List user agreements |
| GET | /api/user-agreements/{uuid}/ |
Retrieve user agreement |
| POST | /api/user-agreements/ |
Create |
| PUT | /api/user-agreements/{uuid}/ |
Update |
| PATCH | /api/user-agreements/{uuid}/ |
Partial Update |
| DELETE | /api/user-agreements/{uuid}/ |
Delete |
List user agreements
Retrieve a list of user agreements (Terms of Service and Privacy Policy). Supports filtering by agreement type and language with fallback behavior.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 | |
- Model Source:
AgreementTypeEnum - API Source:
user_agreements_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
agreement_type |
string | Enum: TOS, PP |
language |
string | ISO 639-1 language code (e.g., 'en', 'de', 'et'). Returns requested language or falls back to default version if unavailable. |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
content |
string | |
agreement_type |
string | Enum: TOS, PP |
language |
string | ISO 639-1 language code (e.g., 'en', 'de', 'et'). Leave empty for the default version. |
created |
string (date-time) | |
modified |
string (date-time) |
Retrieve user agreement
Fetch the details of a specific user agreement by its UUID.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
user_agreements_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
content |
string | |
agreement_type |
string | Enum: TOS, PP |
language |
string | ISO 639-1 language code (e.g., 'en', 'de', 'et'). Leave empty for the default version. |
created |
string (date-time) | |
modified |
string (date-time) |
Create
1 2 3 4 5 6 7 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
UserAgreementRequest - API Source:
user_agreements_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
| Field | Type | Required | Description |
|---|---|---|---|
content |
string | ✓ | |
agreement_type |
string | ✓ | Enum: TOS, PP |
language |
string | ✓ | ISO 639-1 language code (e.g., 'en', 'de', 'et'). Leave empty for the default version. |
201 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
content |
string | |
agreement_type |
string | Enum: TOS, PP |
language |
string | ISO 639-1 language code (e.g., 'en', 'de', 'et'). Leave empty for the default version. |
created |
string (date-time) | |
modified |
string (date-time) |
Update
1 2 3 4 5 6 7 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | |
- Model Source:
UserAgreementRequest - API Source:
user_agreements_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
content |
string | ✓ | |
agreement_type |
string | ✓ | Enum: TOS, PP |
language |
string | ✓ | ISO 639-1 language code (e.g., 'en', 'de', 'et'). Leave empty for the default version. |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
content |
string | |
agreement_type |
string | Enum: TOS, PP |
language |
string | ISO 639-1 language code (e.g., 'en', 'de', 'et'). Leave empty for the default version. |
created |
string (date-time) | |
modified |
string (date-time) |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedUserAgreementRequest - API Source:
user_agreements_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
content |
string | ||
agreement_type |
string | Enum: TOS, PP |
|
language |
string | ISO 639-1 language code (e.g., 'en', 'de', 'et'). Leave empty for the default version. |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
content |
string | |
agreement_type |
string | Enum: TOS, PP |
language |
string | ISO 639-1 language code (e.g., 'en', 'de', 'et'). Leave empty for the default version. |
created |
string (date-time) | |
modified |
string (date-time) |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
user_agreements_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Version
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/version/ |
Get application version |
Get application version
Retrieves the current installed version of the application and the latest available version from GitHub (if available). Requires staff or support user permissions.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
- API Source:
version_retrieve
1 2 3 4 5 6 7 8 9 10 | |
200 -
| Field | Type | Description |
|---|---|---|
version |
string | Current installed version of the application |
latest_version |
string | Latest available version from GitHub, if available. |
Marketplace
Accounts
Marketplace Course Accounts
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/marketplace-course-accounts/ |
List course accounts |
| GET | /api/marketplace-course-accounts/{uuid}/ |
Retrieve a course account |
| POST | /api/marketplace-course-accounts/ |
Create a course account |
| POST | /api/marketplace-course-accounts/create_bulk/ |
Bulk create course accounts |
| DELETE | /api/marketplace-course-accounts/{uuid}/ |
Delete (close) a course account |
List course accounts
Returns a paginated list of course accounts accessible to the current user.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- Model Source:
CourseAccountOEnum - Model Source:
ServiceAccountState - API Source:
marketplace_course_accounts_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
email |
string | Email contains |
o |
array | Ordering |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
project_end_date_after |
string (date) | Project end date range |
project_end_date_before |
string (date) | Project end date range |
project_start_date_after |
string (date) | Project start date range |
project_start_date_before |
string (date) | Project start date range |
project_uuid |
string (uuid) | Project UUID |
state |
array | Course account state |
username |
string | Username |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
created |
string (date-time) |
modified |
string (date-time) |
project |
string (uuid) |
project_uuid |
string (uuid) |
project_name |
string |
project_slug |
string |
project_start_date |
string (date) |
project_end_date |
string (date) |
user_uuid |
string (uuid) |
username |
string |
customer_uuid |
string (uuid) |
customer_name |
string |
state |
any |
email |
string (email) |
description |
string |
error_message |
string |
error_traceback |
string |
Retrieve a course account
Returns the details of a specific course account.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_course_accounts_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
created |
string (date-time) |
modified |
string (date-time) |
project |
string (uuid) |
project_uuid |
string (uuid) |
project_name |
string |
project_slug |
string |
project_start_date |
string (date) |
project_end_date |
string (date) |
user_uuid |
string (uuid) |
username |
string |
customer_uuid |
string (uuid) |
customer_name |
string |
state |
any |
email |
string (email) |
description |
string |
error_message |
string |
error_traceback |
string |
Create a course account
Creates a new temporary course account within a specified course project.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
- Model Source:
CourseAccountRequest - API Source:
marketplace_course_accounts_create
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Field | Type | Required |
|---|---|---|
project |
string (uuid) | ✓ |
email |
string (email) | |
description |
string |
201 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
created |
string (date-time) |
modified |
string (date-time) |
project |
string (uuid) |
project_uuid |
string (uuid) |
project_name |
string |
project_slug |
string |
project_start_date |
string (date) |
project_end_date |
string (date) |
user_uuid |
string (uuid) |
username |
string |
customer_uuid |
string (uuid) |
customer_name |
string |
state |
any |
email |
string (email) |
description |
string |
error_message |
string |
error_traceback |
string |
Bulk create course accounts
Creates multiple course accounts within a specified course project in a single request.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 | |
- Model Source:
CourseAccountOEnum - Model Source:
CourseAccountsBulkCreateRequest - Model Source:
ServiceAccountState - API Source:
marketplace_course_accounts_create_bulk
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Name | Type | Description |
|---|---|---|
email |
string | Email contains |
o |
array | Ordering |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
project_end_date_after |
string (date) | Project end date range |
project_end_date_before |
string (date) | Project end date range |
project_start_date_after |
string (date) | Project start date range |
project_start_date_before |
string (date) | Project start date range |
project_uuid |
string (uuid) | Project UUID |
state |
array | Course account state |
username |
string | Username |
| Field | Type | Required |
|---|---|---|
course_accounts |
array of objects | ✓ |
course_accounts.email |
string (email) | |
course_accounts.description |
string | |
project |
string (uuid) | ✓ |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
created |
string (date-time) |
modified |
string (date-time) |
project |
string (uuid) |
project_uuid |
string (uuid) |
project_name |
string |
project_slug |
string |
project_start_date |
string (date) |
project_end_date |
string (date) |
user_uuid |
string (uuid) |
username |
string |
customer_uuid |
string (uuid) |
customer_name |
string |
state |
any |
email |
string (email) |
description |
string |
error_message |
string |
error_traceback |
string |
Delete (close) a course account
Deletes a course account, which triggers a 'close' operation in the backend.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_course_accounts_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Marketplace Customer Service Accounts
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/marketplace-customer-service-accounts/ |
List service accounts |
| GET | /api/marketplace-customer-service-accounts/{uuid}/ |
Retrieve a service account |
| POST | /api/marketplace-customer-service-accounts/ |
Create a customer service account |
| PUT | /api/marketplace-customer-service-accounts/{uuid}/ |
Update a service account |
| PATCH | /api/marketplace-customer-service-accounts/{uuid}/ |
Partially update a service account |
| DELETE | /api/marketplace-customer-service-accounts/{uuid}/ |
Close a customer service account |
| Other Actions | ||
| POST | /api/marketplace-customer-service-accounts/{uuid}/rotate_api_key/ |
Rotate API key for a customer service account |
Core CRUD
List service accounts
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 | |
- Model Source:
ServiceAccountState - API Source:
marketplace_customer_service_accounts_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
customer |
string (uri) | Customer URL |
customer_uuid |
string (uuid) | Customer UUID |
email |
string | Email contains |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
state |
array | Service account state |
username |
string | Username |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
created |
string (date-time) |
modified |
string (date-time) |
username |
string |
description |
string |
error_message |
string |
error_traceback |
string |
state |
any |
token |
string |
email |
string (email) |
expires_at |
string |
preferred_identifier |
string |
customer |
string (uuid) |
customer_uuid |
string (uuid) |
customer_name |
string |
Retrieve a service account
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_customer_service_accounts_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
created |
string (date-time) |
modified |
string (date-time) |
username |
string |
description |
string |
error_message |
string |
error_traceback |
string |
state |
any |
token |
string |
email |
string (email) |
expires_at |
string |
preferred_identifier |
string |
customer |
string (uuid) |
customer_uuid |
string (uuid) |
customer_name |
string |
Create a customer service account
Creates a new service account scoped to a specific customer (organization). This generates an API key that can be used for automated access to resources across all projects within that customer.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
- Model Source:
CustomerServiceAccountRequest - API Source:
marketplace_customer_service_accounts_create
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Field | Type | Required |
|---|---|---|
username |
string | |
description |
string | |
error_traceback |
string | |
email |
string (email) | |
preferred_identifier |
string | |
customer |
string (uuid) | ✓ |
201 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
created |
string (date-time) |
modified |
string (date-time) |
username |
string |
description |
string |
error_message |
string |
error_traceback |
string |
state |
any |
token |
string |
email |
string (email) |
expires_at |
string |
preferred_identifier |
string |
customer |
string (uuid) |
customer_uuid |
string (uuid) |
customer_name |
string |
Update a service account
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
CustomerServiceAccountRequest - API Source:
marketplace_customer_service_accounts_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
username |
string | |
description |
string | |
error_traceback |
string | |
email |
string (email) | |
preferred_identifier |
string | |
customer |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
created |
string (date-time) |
modified |
string (date-time) |
username |
string |
description |
string |
error_message |
string |
error_traceback |
string |
state |
any |
token |
string |
email |
string (email) |
expires_at |
string |
preferred_identifier |
string |
customer |
string (uuid) |
customer_uuid |
string (uuid) |
customer_name |
string |
Partially update a service account
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedCustomerServiceAccountRequest - API Source:
marketplace_customer_service_accounts_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
username |
string | |
description |
string | |
error_traceback |
string | |
email |
string (email) | |
preferred_identifier |
string | |
customer |
string (uuid) |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
created |
string (date-time) |
modified |
string (date-time) |
username |
string |
description |
string |
error_message |
string |
error_traceback |
string |
state |
any |
token |
string |
email |
string (email) |
expires_at |
string |
preferred_identifier |
string |
customer |
string (uuid) |
customer_uuid |
string (uuid) |
customer_name |
string |
Close a customer service account
Deactivates a customer service account and revokes its API key.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_customer_service_accounts_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
Rotate API key for a customer service account
Generates a new API key for the service account, immediately invalidating the old one. The new key is returned in the response.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
created |
string (date-time) |
modified |
string (date-time) |
username |
string |
description |
string |
error_message |
string |
error_traceback |
string |
state |
any |
token |
string |
email |
string (email) |
expires_at |
string |
preferred_identifier |
string |
customer |
string (uuid) |
customer_uuid |
string (uuid) |
customer_name |
string |
Marketplace Offering User Roles
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/marketplace-offering-user-roles/ |
List Marketplace Offering User Roles |
| GET | /api/marketplace-offering-user-roles/{uuid}/ |
Retrieve |
| POST | /api/marketplace-offering-user-roles/ |
Create |
| PUT | /api/marketplace-offering-user-roles/{uuid}/ |
Update |
| PATCH | /api/marketplace-offering-user-roles/{uuid}/ |
Partial Update |
| DELETE | /api/marketplace-offering-user-roles/{uuid}/ |
Delete |
List Marketplace Offering User Roles
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
marketplace_offering_user_roles_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
offering |
string (uri) | |
offering_slug |
array | Multiple values may be separated by commas. |
offering_uuid |
array | Multiple values may be separated by commas. |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
parent_offering_uuid |
string (uuid) |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
name |
string | |
uuid |
string (uuid) | |
offering |
string (uri) | |
offering_uuid |
string (uuid) | |
offering_name |
string | |
scope_type |
string | Level this role applies at, e.g. 'cluster', 'project'. Empty means offering-wide. |
scope_type_label |
string | Human-readable label for scope_type shown to end users, e.g. 'Rancher Project', 'Cluster Namespace'. Falls back to capitalized scope_type if empty. |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_offering_user_roles_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
name |
string | |
uuid |
string (uuid) | |
offering |
string (uri) | |
offering_uuid |
string (uuid) | |
offering_name |
string | |
scope_type |
string | Level this role applies at, e.g. 'cluster', 'project'. Empty means offering-wide. |
scope_type_label |
string | Human-readable label for scope_type shown to end users, e.g. 'Rancher Project', 'Cluster Namespace'. Falls back to capitalized scope_type if empty. |
Create
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
OfferingUserRoleRequest - API Source:
marketplace_offering_user_roles_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ✓ | |
offering |
string (uri) | ✓ | |
scope_type |
string | Level this role applies at, e.g. 'cluster', 'project'. Empty means offering-wide. | |
scope_type_label |
string | Human-readable label for scope_type shown to end users, e.g. 'Rancher Project', 'Cluster Namespace'. Falls back to capitalized scope_type if empty. |
201 -
| Field | Type | Description |
|---|---|---|
name |
string | |
uuid |
string (uuid) | |
offering |
string (uri) | |
offering_uuid |
string (uuid) | |
offering_name |
string | |
scope_type |
string | Level this role applies at, e.g. 'cluster', 'project'. Empty means offering-wide. |
scope_type_label |
string | Human-readable label for scope_type shown to end users, e.g. 'Rancher Project', 'Cluster Namespace'. Falls back to capitalized scope_type if empty. |
Update
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
OfferingUserRoleRequest - API Source:
marketplace_offering_user_roles_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ✓ | |
offering |
string (uri) | ✓ | |
scope_type |
string | Level this role applies at, e.g. 'cluster', 'project'. Empty means offering-wide. | |
scope_type_label |
string | Human-readable label for scope_type shown to end users, e.g. 'Rancher Project', 'Cluster Namespace'. Falls back to capitalized scope_type if empty. |
200 -
| Field | Type | Description |
|---|---|---|
name |
string | |
uuid |
string (uuid) | |
offering |
string (uri) | |
offering_uuid |
string (uuid) | |
offering_name |
string | |
scope_type |
string | Level this role applies at, e.g. 'cluster', 'project'. Empty means offering-wide. |
scope_type_label |
string | Human-readable label for scope_type shown to end users, e.g. 'Rancher Project', 'Cluster Namespace'. Falls back to capitalized scope_type if empty. |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedOfferingUserRoleRequest - API Source:
marketplace_offering_user_roles_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ||
offering |
string (uri) | ||
scope_type |
string | Level this role applies at, e.g. 'cluster', 'project'. Empty means offering-wide. | |
scope_type_label |
string | Human-readable label for scope_type shown to end users, e.g. 'Rancher Project', 'Cluster Namespace'. Falls back to capitalized scope_type if empty. |
200 -
| Field | Type | Description |
|---|---|---|
name |
string | |
uuid |
string (uuid) | |
offering |
string (uri) | |
offering_uuid |
string (uuid) | |
offering_name |
string | |
scope_type |
string | Level this role applies at, e.g. 'cluster', 'project'. Empty means offering-wide. |
scope_type_label |
string | Human-readable label for scope_type shown to end users, e.g. 'Rancher Project', 'Cluster Namespace'. Falls back to capitalized scope_type if empty. |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_offering_user_roles_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Marketplace Offering Users
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/marketplace-offering-users/ |
List offering users |
| GET | /api/marketplace-offering-users/{uuid}/ |
Retrieve an offering user |
| POST | /api/marketplace-offering-users/ |
Create an offering user |
| POST | /api/marketplace-offering-users/{uuid}/update_restricted/ |
Update restriction status |
| PUT | /api/marketplace-offering-users/{uuid}/ |
Update |
| PATCH | /api/marketplace-offering-users/{uuid}/ |
Partial Update |
| PATCH | /api/marketplace-offering-users/{uuid}/update_comments/ |
Update service provider comments |
| DELETE | /api/marketplace-offering-users/{uuid}/ |
Delete an offering user |
| Other Actions | ||
| GET | /api/marketplace-offering-users/{uuid}/checklist/ |
Get checklist with questions and existing answers |
| GET | /api/marketplace-offering-users/{uuid}/checklist_review/ |
Checklist review |
| GET | /api/marketplace-offering-users/checklist-template/ |
Get checklist template for creating new objects |
| GET | /api/marketplace-offering-users/{uuid}/completion_review_status/ |
Get checklist completion status with review triggers (reviewers only) |
| GET | /api/marketplace-offering-users/{uuid}/completion_status/ |
Get checklist completion status |
| GET | /api/marketplace-offering-users/profile_field_warnings/ |
Get profile field warnings |
| POST | /api/marketplace-offering-users/{uuid}/begin_creating/ |
Begin creation process |
| POST | /api/marketplace-offering-users/{uuid}/request_deletion/ |
Request deletion of an offering user |
| POST | /api/marketplace-offering-users/{uuid}/set_deleted/ |
Set state to Deleted |
| POST | /api/marketplace-offering-users/{uuid}/set_deleting/ |
Begin deletion process |
| POST | /api/marketplace-offering-users/{uuid}/set_error_creating/ |
Set state to Error Creating |
| POST | /api/marketplace-offering-users/{uuid}/set_error_deleting/ |
Set state to Error Deleting |
| POST | /api/marketplace-offering-users/{uuid}/set_ok/ |
Set state to OK |
| POST | /api/marketplace-offering-users/{uuid}/set_pending_account_linking/ |
Set state to Pending Account Linking |
| POST | /api/marketplace-offering-users/{uuid}/set_pending_additional_validation/ |
Set state to Pending Additional Validation |
| POST | /api/marketplace-offering-users/{uuid}/set_validation_complete/ |
Set state to Validation Complete |
| POST | /api/marketplace-offering-users/{uuid}/submit_answers/ |
Submit checklist answers |
Core CRUD
List offering users
Returns a paginated list of users associated with offerings. The visibility of users depends on the role of the authenticated user. Staff and support can see all users. Service providers can see users of their offerings if the user has consented. Regular users can only see their own offering-user records.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
OfferingUserFieldEnum - Model Source:
OfferingUserOEnum - Model Source:
OfferingUserState - API Source:
marketplace_offering_users_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
created |
string (date-time) | Created after |
field |
array | |
has_complete_profile |
boolean | User has complete profile for the offering |
has_consent |
boolean | User Has Consent |
is_restricted |
boolean | Is restricted |
modified |
string (date-time) | Modified after |
o |
array | Ordering |
offering |
string (uri) | |
offering_slug |
array | Multiple values may be separated by commas. |
offering_uuid |
array | Multiple values may be separated by commas. |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
parent_offering_uuid |
string (uuid) | |
provider_uuid |
string (uuid) | Provider UUID |
query |
string | Search by offering name, username or user name |
state |
array | Offering user state |
user_username |
string | User username |
user_uuid |
string (uuid) | User UUID |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
user |
string (uri) | |
offering |
string (uri) | |
username |
string | |
offering_uuid |
string (uuid) | |
offering_name |
string | |
user_uuid |
string (uuid) | |
user_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
user_full_name |
string | |
user_first_name |
string | |
user_last_name |
string | |
user_email |
string (email) | |
user_phone_number |
string | |
user_organization |
string | |
user_job_title |
string | |
user_affiliations |
any | Person's affiliation within organization such as student, faculty, staff. |
user_gender |
any | ISO 5218 gender code |
user_personal_title |
string | Honorific title (Mr, Ms, Dr, Prof, etc.) |
user_place_of_birth |
string | |
user_country_of_residence |
string | |
user_nationality |
string | Primary citizenship (ISO 3166-1 alpha-2 code) |
user_nationalities |
any | List of all citizenships (ISO 3166-1 alpha-2 codes) |
user_organization_country |
string | |
user_organization_type |
string | SCHAC URN (e.g., urn:schac:homeOrganizationType:int:university) |
user_organization_registry_code |
string | Company registration code of the user's organization, if known |
user_eduperson_assurance |
any | REFEDS assurance profile URIs from identity provider |
user_civil_number |
string | |
user_birth_date |
string (date) | |
user_identity_source |
string | Indicates what identity provider was used. |
user_active_isds |
any | List of ISDs that have asserted this user exists. User is deactivated when this becomes empty. |
created |
string (date-time) | |
modified |
string (date-time) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
is_restricted |
boolean | Signal to service if the user account is restricted or not |
state |
any | |
service_provider_comment |
string | Additional comment for pending states like validation or account linking |
service_provider_comment_url |
string (uri) | URL link for additional information or actions related to service provider comment |
has_consent |
boolean | Check if the user has active consent for this offering. |
requires_reconsent |
boolean | Check if the user needs to re-consent due to ToS changes. |
has_compliance_checklist |
boolean | Check if the offering user has a connected compliance checklist completion. |
consent_data |
object (free-form) | User consent data including uuid, version, and agreement_date |
is_profile_complete |
boolean | |
missing_profile_attributes |
array of strings |
Retrieve an offering user
Returns the details of a specific offering-user link. Visibility follows the same rules as the list view.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
OfferingUserFieldEnum - API Source:
marketplace_offering_users_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
user |
string (uri) | |
offering |
string (uri) | |
username |
string | |
offering_uuid |
string (uuid) | |
offering_name |
string | |
user_uuid |
string (uuid) | |
user_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
user_full_name |
string | |
user_first_name |
string | |
user_last_name |
string | |
user_email |
string (email) | |
user_phone_number |
string | |
user_organization |
string | |
user_job_title |
string | |
user_affiliations |
any | Person's affiliation within organization such as student, faculty, staff. |
user_gender |
any | ISO 5218 gender code |
user_personal_title |
string | Honorific title (Mr, Ms, Dr, Prof, etc.) |
user_place_of_birth |
string | |
user_country_of_residence |
string | |
user_nationality |
string | Primary citizenship (ISO 3166-1 alpha-2 code) |
user_nationalities |
any | List of all citizenships (ISO 3166-1 alpha-2 codes) |
user_organization_country |
string | |
user_organization_type |
string | SCHAC URN (e.g., urn:schac:homeOrganizationType:int:university) |
user_organization_registry_code |
string | Company registration code of the user's organization, if known |
user_eduperson_assurance |
any | REFEDS assurance profile URIs from identity provider |
user_civil_number |
string | |
user_birth_date |
string (date) | |
user_identity_source |
string | Indicates what identity provider was used. |
user_active_isds |
any | List of ISDs that have asserted this user exists. User is deactivated when this becomes empty. |
created |
string (date-time) | |
modified |
string (date-time) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
is_restricted |
boolean | Signal to service if the user account is restricted or not |
state |
any | |
service_provider_comment |
string | Additional comment for pending states like validation or account linking |
service_provider_comment_url |
string (uri) | URL link for additional information or actions related to service provider comment |
has_consent |
boolean | Check if the user has active consent for this offering. |
requires_reconsent |
boolean | Check if the user needs to re-consent due to ToS changes. |
has_compliance_checklist |
boolean | Check if the offering user has a connected compliance checklist completion. |
consent_data |
object (free-form) | User consent data including uuid, version, and agreement_date |
is_profile_complete |
boolean | |
missing_profile_attributes |
array of strings |
Create an offering user
Associates a user with a specific offering, creating an offering-specific user account. This is typically done by a service provider.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
- Model Source:
OfferingUserRequest - API Source:
marketplace_offering_users_create
1 2 3 4 5 6 7 8 9 10 | |
| Field | Type | Required |
|---|---|---|
user |
string (uri) | |
offering |
string (uri) | |
username |
string | |
offering_uuid |
string (uuid) | |
user_uuid |
string (uuid) |
201 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
user |
string (uri) | |
offering |
string (uri) | |
username |
string | |
offering_uuid |
string (uuid) | |
offering_name |
string | |
user_uuid |
string (uuid) | |
user_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
user_full_name |
string | |
user_first_name |
string | |
user_last_name |
string | |
user_email |
string (email) | |
user_phone_number |
string | |
user_organization |
string | |
user_job_title |
string | |
user_affiliations |
any | Person's affiliation within organization such as student, faculty, staff. |
user_gender |
any | ISO 5218 gender code |
user_personal_title |
string | Honorific title (Mr, Ms, Dr, Prof, etc.) |
user_place_of_birth |
string | |
user_country_of_residence |
string | |
user_nationality |
string | Primary citizenship (ISO 3166-1 alpha-2 code) |
user_nationalities |
any | List of all citizenships (ISO 3166-1 alpha-2 codes) |
user_organization_country |
string | |
user_organization_type |
string | SCHAC URN (e.g., urn:schac:homeOrganizationType:int:university) |
user_organization_registry_code |
string | Company registration code of the user's organization, if known |
user_eduperson_assurance |
any | REFEDS assurance profile URIs from identity provider |
user_civil_number |
string | |
user_birth_date |
string (date) | |
user_identity_source |
string | Indicates what identity provider was used. |
user_active_isds |
any | List of ISDs that have asserted this user exists. User is deactivated when this becomes empty. |
created |
string (date-time) | |
modified |
string (date-time) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
is_restricted |
boolean | Signal to service if the user account is restricted or not |
state |
any | |
service_provider_comment |
string | Additional comment for pending states like validation or account linking |
service_provider_comment_url |
string (uri) | URL link for additional information or actions related to service provider comment |
has_consent |
boolean | Check if the user has active consent for this offering. |
requires_reconsent |
boolean | Check if the user needs to re-consent due to ToS changes. |
has_compliance_checklist |
boolean | Check if the offering user has a connected compliance checklist completion. |
consent_data |
object (free-form) | User consent data including uuid, version, and agreement_date |
is_profile_complete |
boolean | |
missing_profile_attributes |
array of strings |
Update restriction status
Allows a service provider to mark an offering user as restricted or unrestricted. A restricted user may have limited access to the resource.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
OfferingUserUpdateRestrictionRequest - API Source:
marketplace_offering_users_update_restricted
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
is_restricted |
boolean | ✓ | Whether the offering user should be restricted from accessing resources |
200 - No response body
Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
OfferingUserRequest - API Source:
marketplace_offering_users_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
user |
string (uri) | |
offering |
string (uri) | |
username |
string | |
offering_uuid |
string (uuid) | |
user_uuid |
string (uuid) |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
user |
string (uri) | |
offering |
string (uri) | |
username |
string | |
offering_uuid |
string (uuid) | |
offering_name |
string | |
user_uuid |
string (uuid) | |
user_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
user_full_name |
string | |
user_first_name |
string | |
user_last_name |
string | |
user_email |
string (email) | |
user_phone_number |
string | |
user_organization |
string | |
user_job_title |
string | |
user_affiliations |
any | Person's affiliation within organization such as student, faculty, staff. |
user_gender |
any | ISO 5218 gender code |
user_personal_title |
string | Honorific title (Mr, Ms, Dr, Prof, etc.) |
user_place_of_birth |
string | |
user_country_of_residence |
string | |
user_nationality |
string | Primary citizenship (ISO 3166-1 alpha-2 code) |
user_nationalities |
any | List of all citizenships (ISO 3166-1 alpha-2 codes) |
user_organization_country |
string | |
user_organization_type |
string | SCHAC URN (e.g., urn:schac:homeOrganizationType:int:university) |
user_organization_registry_code |
string | Company registration code of the user's organization, if known |
user_eduperson_assurance |
any | REFEDS assurance profile URIs from identity provider |
user_civil_number |
string | |
user_birth_date |
string (date) | |
user_identity_source |
string | Indicates what identity provider was used. |
user_active_isds |
any | List of ISDs that have asserted this user exists. User is deactivated when this becomes empty. |
created |
string (date-time) | |
modified |
string (date-time) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
is_restricted |
boolean | Signal to service if the user account is restricted or not |
state |
any | |
service_provider_comment |
string | Additional comment for pending states like validation or account linking |
service_provider_comment_url |
string (uri) | URL link for additional information or actions related to service provider comment |
has_consent |
boolean | Check if the user has active consent for this offering. |
requires_reconsent |
boolean | Check if the user needs to re-consent due to ToS changes. |
has_compliance_checklist |
boolean | Check if the offering user has a connected compliance checklist completion. |
consent_data |
object (free-form) | User consent data including uuid, version, and agreement_date |
is_profile_complete |
boolean | |
missing_profile_attributes |
array of strings |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedOfferingUserRequest - API Source:
marketplace_offering_users_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
user |
string (uri) | |
offering |
string (uri) | |
username |
string | |
offering_uuid |
string (uuid) | |
user_uuid |
string (uuid) |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
user |
string (uri) | |
offering |
string (uri) | |
username |
string | |
offering_uuid |
string (uuid) | |
offering_name |
string | |
user_uuid |
string (uuid) | |
user_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
user_full_name |
string | |
user_first_name |
string | |
user_last_name |
string | |
user_email |
string (email) | |
user_phone_number |
string | |
user_organization |
string | |
user_job_title |
string | |
user_affiliations |
any | Person's affiliation within organization such as student, faculty, staff. |
user_gender |
any | ISO 5218 gender code |
user_personal_title |
string | Honorific title (Mr, Ms, Dr, Prof, etc.) |
user_place_of_birth |
string | |
user_country_of_residence |
string | |
user_nationality |
string | Primary citizenship (ISO 3166-1 alpha-2 code) |
user_nationalities |
any | List of all citizenships (ISO 3166-1 alpha-2 codes) |
user_organization_country |
string | |
user_organization_type |
string | SCHAC URN (e.g., urn:schac:homeOrganizationType:int:university) |
user_organization_registry_code |
string | Company registration code of the user's organization, if known |
user_eduperson_assurance |
any | REFEDS assurance profile URIs from identity provider |
user_civil_number |
string | |
user_birth_date |
string (date) | |
user_identity_source |
string | Indicates what identity provider was used. |
user_active_isds |
any | List of ISDs that have asserted this user exists. User is deactivated when this becomes empty. |
created |
string (date-time) | |
modified |
string (date-time) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
is_restricted |
boolean | Signal to service if the user account is restricted or not |
state |
any | |
service_provider_comment |
string | Additional comment for pending states like validation or account linking |
service_provider_comment_url |
string (uri) | URL link for additional information or actions related to service provider comment |
has_consent |
boolean | Check if the user has active consent for this offering. |
requires_reconsent |
boolean | Check if the user needs to re-consent due to ToS changes. |
has_compliance_checklist |
boolean | Check if the offering user has a connected compliance checklist completion. |
consent_data |
object (free-form) | User consent data including uuid, version, and agreement_date |
is_profile_complete |
boolean | |
missing_profile_attributes |
array of strings |
Update service provider comments
Allows a service provider to update the service_provider_comment and service_provider_comment_url fields for an offering user. This is often used to provide feedback or instructions during a pending state.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedOfferingUserServiceProviderCommentRequest - API Source:
marketplace_offering_users_update_comments_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
service_provider_comment |
string | ||
service_provider_comment_url |
string (uri) | URL link for additional information or actions related to service provider comment |
200 -
| Field | Type | Description |
|---|---|---|
service_provider_comment |
string | |
service_provider_comment_url |
string (uri) | URL link for additional information or actions related to service provider comment |
Delete an offering user
Removes the association between a user and an offering. This action may trigger backend cleanup processes depending on the offering type.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_offering_users_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
Get checklist with questions and existing answers
Get checklist with questions and existing answers.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_offering_users_checklist_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
include_all |
boolean | If true, returns all questions including hidden ones (for dynamic form visibility). Default: false. |
200 -
| Field | Type | Description |
|---|---|---|
checklist |
object (free-form) | |
completion |
object | |
completion.uuid |
string (uuid) | |
completion.is_completed |
boolean | Whether all required questions have been answered |
completion.completion_percentage |
number (double) | |
completion.unanswered_required_questions |
array of anys | |
completion.checklist_name |
string | |
completion.checklist_description |
string | |
completion.created |
string (date-time) | |
completion.modified |
string (date-time) | |
questions |
array of objects | |
questions.uuid |
string (uuid) | |
questions.description |
string | |
questions.user_guidance |
string | |
questions.question_type |
any | Type of question and expected answer format |
questions.required |
boolean | |
questions.order |
integer | |
questions.existing_answer |
object (free-form) | |
questions.question_options |
array of anys | |
questions.min_value |
string (decimal) | Minimum value allowed for NUMBER, YEAR, and RATING type questions |
questions.max_value |
string (decimal) | Maximum value allowed for NUMBER, YEAR, and RATING type questions |
questions.allowed_file_types |
any | List of allowed file extensions (e.g., ['.pdf', '.doc', '.docx']). If empty, all file types are allowed. |
questions.allowed_mime_types |
any | List of allowed MIME types (e.g., ['application/pdf', 'application/msword']). If empty, MIME type validation is not enforced. When both extensions and MIME types are specified, files must match both criteria for security. |
questions.max_file_size_mb |
integer | Maximum file size in megabytes. If not set, no size limit is enforced. |
questions.max_files_count |
integer | Maximum number of files allowed for MULTIPLE_FILES type questions. If not set, no count limit is enforced. |
questions.dependencies_info |
object (free-form) |
400 -
404 -
Checklist review
Get checklist with questions and existing answers including review logic (reviewers only).
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
checklist |
object (free-form) | |
completion |
object | |
completion.uuid |
string (uuid) | |
completion.is_completed |
boolean | Whether all required questions have been answered |
completion.completion_percentage |
number (double) | |
completion.unanswered_required_questions |
array of anys | |
completion.checklist_name |
string | |
completion.checklist_description |
string | |
completion.created |
string (date-time) | |
completion.modified |
string (date-time) | |
completion.requires_review |
boolean | Whether any answers triggered review requirements |
completion.reviewed_by |
integer | User who reviewed the checklist completion |
completion.reviewed_by_name |
string | |
completion.reviewed_at |
string (date-time) | |
completion.review_notes |
string | Notes from the reviewer |
completion.review_trigger_summary |
array of anys | |
questions |
array of objects | |
questions.uuid |
string (uuid) | |
questions.description |
string | |
questions.user_guidance |
string | |
questions.question_type |
any | Type of question and expected answer format |
questions.required |
boolean | |
questions.order |
integer | |
questions.existing_answer |
object (free-form) | |
questions.question_options |
array of anys | |
questions.min_value |
string (decimal) | Minimum value allowed for NUMBER, YEAR, and RATING type questions |
questions.max_value |
string (decimal) | Maximum value allowed for NUMBER, YEAR, and RATING type questions |
questions.allowed_file_types |
any | List of allowed file extensions (e.g., ['.pdf', '.doc', '.docx']). If empty, all file types are allowed. |
questions.allowed_mime_types |
any | List of allowed MIME types (e.g., ['application/pdf', 'application/msword']). If empty, MIME type validation is not enforced. When both extensions and MIME types are specified, files must match both criteria for security. |
questions.max_file_size_mb |
integer | Maximum file size in megabytes. If not set, no size limit is enforced. |
questions.max_files_count |
integer | Maximum number of files allowed for MULTIPLE_FILES type questions. If not set, no count limit is enforced. |
questions.dependencies_info |
object (free-form) | |
questions.operator |
any | |
questions.review_answer_value |
any | Answer value that trigger review. |
questions.always_requires_review |
boolean | This question always requires review regardless of answer |
400 -
404 -
Get checklist template for creating new objects
Get checklist template for creating new objects.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required | Description |
|---|---|---|---|
parent_uuid |
string (uuid) | ✓ | UUID of the parent object (e.g., customer UUID for new projects) |
200 -
| Field | Type | Description |
|---|---|---|
checklist |
object (free-form) | |
questions |
array of objects | |
questions.uuid |
string (uuid) | |
questions.required |
boolean | |
questions.description |
string | |
questions.user_guidance |
string | Additional guidance text visible to users when answering and reviewing |
questions.question_options |
array of objects | |
questions.question_options.uuid |
string (uuid) | |
questions.question_options.label |
string | |
questions.question_options.order |
integer | |
questions.question_type |
any | Type of question and expected answer format |
questions.order |
integer | |
questions.min_value |
string (decimal) | Minimum value allowed for NUMBER, YEAR, and RATING type questions |
questions.max_value |
string (decimal) | Maximum value allowed for NUMBER, YEAR, and RATING type questions |
questions.allowed_file_types |
any | List of allowed file extensions (e.g., ['.pdf', '.doc', '.docx']). If empty, all file types are allowed. |
questions.allowed_mime_types |
any | List of allowed MIME types (e.g., ['application/pdf', 'application/msword']). If empty, MIME type validation is not enforced. When both extensions and MIME types are specified, files must match both criteria for security. |
questions.max_file_size_mb |
integer | Maximum file size in megabytes. If not set, no size limit is enforced. |
questions.max_files_count |
integer | Maximum number of files allowed for MULTIPLE_FILES type questions. If not set, no count limit is enforced. |
questions.operator |
any | |
questions.review_answer_value |
any | Answer value that trigger review. |
questions.always_requires_review |
boolean | This question always requires review regardless of answer |
questions.guidance_answer_value |
any | Answer value that triggers display of user guidance. |
questions.guidance_operator |
any | Operator to use when comparing answer with guidance_answer_value |
questions.always_show_guidance |
boolean | Show user guidance always, regardless of answer. If False, guidance is conditional on answer matching guidance_answer_value with guidance_operator |
questions.dependency_logic_operator |
any | Defines how multiple dependencies are evaluated. AND: All dependencies must be satisfied. OR: At least one dependency must be satisfied. |
initial_visible_questions |
array of objects | |
initial_visible_questions.uuid |
string (uuid) | |
initial_visible_questions.required |
boolean | |
initial_visible_questions.description |
string | |
initial_visible_questions.user_guidance |
string | Additional guidance text visible to users when answering and reviewing |
initial_visible_questions.question_options |
array of objects | |
initial_visible_questions.question_options.uuid |
string (uuid) | |
initial_visible_questions.question_options.label |
string | |
initial_visible_questions.question_options.order |
integer | |
initial_visible_questions.question_type |
any | Type of question and expected answer format |
initial_visible_questions.order |
integer | |
initial_visible_questions.min_value |
string (decimal) | Minimum value allowed for NUMBER, YEAR, and RATING type questions |
initial_visible_questions.max_value |
string (decimal) | Maximum value allowed for NUMBER, YEAR, and RATING type questions |
initial_visible_questions.allowed_file_types |
any | List of allowed file extensions (e.g., ['.pdf', '.doc', '.docx']). If empty, all file types are allowed. |
initial_visible_questions.allowed_mime_types |
any | List of allowed MIME types (e.g., ['application/pdf', 'application/msword']). If empty, MIME type validation is not enforced. When both extensions and MIME types are specified, files must match both criteria for security. |
initial_visible_questions.max_file_size_mb |
integer | Maximum file size in megabytes. If not set, no size limit is enforced. |
initial_visible_questions.max_files_count |
integer | Maximum number of files allowed for MULTIPLE_FILES type questions. If not set, no count limit is enforced. |
initial_visible_questions.operator |
any | |
initial_visible_questions.review_answer_value |
any | Answer value that trigger review. |
initial_visible_questions.always_requires_review |
boolean | This question always requires review regardless of answer |
initial_visible_questions.guidance_answer_value |
any | Answer value that triggers display of user guidance. |
initial_visible_questions.guidance_operator |
any | Operator to use when comparing answer with guidance_answer_value |
initial_visible_questions.always_show_guidance |
boolean | Show user guidance always, regardless of answer. If False, guidance is conditional on answer matching guidance_answer_value with guidance_operator |
initial_visible_questions.dependency_logic_operator |
any | Defines how multiple dependencies are evaluated. AND: All dependencies must be satisfied. OR: At least one dependency must be satisfied. |
400 -
404 -
Get checklist completion status with review triggers (reviewers only)
Get checklist completion status with review triggers (reviewers only).
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
is_completed |
boolean | Whether all required questions have been answered |
completion_percentage |
number (double) | |
unanswered_required_questions |
array of anys | |
checklist_name |
string | |
checklist_description |
string | |
created |
string (date-time) | |
modified |
string (date-time) | |
requires_review |
boolean | Whether any answers triggered review requirements |
reviewed_by |
integer | User who reviewed the checklist completion |
reviewed_by_name |
string | |
reviewed_at |
string (date-time) | |
review_notes |
string | Notes from the reviewer |
review_trigger_summary |
array of anys |
400 -
404 -
Get checklist completion status
Get checklist completion status.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
is_completed |
boolean | Whether all required questions have been answered |
completion_percentage |
number (double) | |
unanswered_required_questions |
array of anys | |
checklist_name |
string | |
checklist_description |
string | |
created |
string (date-time) | |
modified |
string (date-time) |
400 -
404 -
Get profile field warnings
Returns a mapping of user profile field names to offerings that expose those fields. When ENFORCE_OFFERING_USER_PROFILE_COMPLETENESS is enabled, clearing a field listed here would make the user invisible to the service provider for the associated offerings.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
1 2 3 4 5 6 7 8 9 10 | |
200 - No response body
Begin creation process
Transitions the offering user state from 'Requested' or 'Error Creating' to 'Creating'. This is typically used by an agent to signal that the creation process has started.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_offering_users_begin_creating
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - No response body
Request deletion of an offering user
Initiates the deletion process for an offering user account by transitioning it to the 'Deletion Requested' state.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_offering_users_request_deletion
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - No response body
Set state to Deleted
Transitions the offering user to the 'Deleted' state, marking the successful completion of the deletion process.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_offering_users_set_deleted
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - No response body
Begin deletion process
Transitions the offering user to the 'Deleting' state. This is typically used by an agent to signal that the deletion process has started.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_offering_users_set_deleting
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - No response body
Set state to Error Creating
Manually moves the offering user into the 'Error Creating' state. This is typically used by an agent to report a failure during the creation process.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_offering_users_set_error_creating
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - No response body
Set state to Error Deleting
Manually moves the offering user into the 'Error Deleting' state. This is typically used by an agent to report a failure during the deletion process.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_offering_users_set_error_deleting
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - No response body
Set state to OK
Manually sets the offering user state to 'OK'. This can be used to recover from an error state or to complete a manual creation process.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_offering_users_set_ok
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - No response body
Set state to Pending Account Linking
Transitions the state to 'Pending Account Linking' and allows a service provider to add a comment and a URL to guide the user.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
OfferingUserStateTransitionRequest - API Source:
marketplace_offering_users_set_pending_account_linking
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
comment |
string | Comment explaining the state transition | |
comment_url |
string (uri) | URL reference related to the state transition comment |
200 - No response body
Set state to Pending Additional Validation
Transitions the state to 'Pending Additional Validation' and allows a service provider to add a comment and a URL for the user to follow.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
OfferingUserStateTransitionRequest - API Source:
marketplace_offering_users_set_pending_additional_validation
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
comment |
string | Comment explaining the state transition | |
comment_url |
string (uri) | URL reference related to the state transition comment |
200 - No response body
Set state to Validation Complete
Transitions the state from a pending validation state to 'OK', indicating that the user has completed the required steps. This clears any service provider comments.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - No response body
Submit checklist answers
Submit checklist answers.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_offering_users_submit_answers
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
The request body is an array of objects, where each object has the following structure:
| Field | Type | Required |
|---|---|---|
question_uuid |
string (uuid) | ✓ |
answer_data |
any | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
detail |
string | |
completion |
object | |
completion.uuid |
string (uuid) | |
completion.is_completed |
boolean | Whether all required questions have been answered |
completion.completion_percentage |
number (double) | |
completion.unanswered_required_questions |
array of anys | |
completion.checklist_name |
string | |
completion.checklist_description |
string | |
completion.created |
string (date-time) | |
completion.modified |
string (date-time) |
400 -
404 -
Marketplace Project Service Accounts
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/marketplace-project-service-accounts/ |
List service accounts |
| GET | /api/marketplace-project-service-accounts/{uuid}/ |
Retrieve a service account |
| POST | /api/marketplace-project-service-accounts/ |
Create a project service account |
| PUT | /api/marketplace-project-service-accounts/{uuid}/ |
Update a service account |
| PATCH | /api/marketplace-project-service-accounts/{uuid}/ |
Partially update a service account |
| DELETE | /api/marketplace-project-service-accounts/{uuid}/ |
Close a project service account |
| Other Actions | ||
| POST | /api/marketplace-project-service-accounts/{uuid}/rotate_api_key/ |
Rotate API key for a project service account |
Core CRUD
List service accounts
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 | |
- Model Source:
ServiceAccountState - API Source:
marketplace_project_service_accounts_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
email |
string | Email contains |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
project |
string (uri) | Project URL |
project_uuid |
string (uuid) | Project UUID |
state |
array | Service account state |
username |
string | Username |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
created |
string (date-time) |
modified |
string (date-time) |
username |
string |
description |
string |
error_message |
string |
error_traceback |
string |
state |
any |
token |
string |
email |
string (email) |
expires_at |
string |
preferred_identifier |
string |
project |
string (uuid) |
project_uuid |
string (uuid) |
project_name |
string |
customer_uuid |
string (uuid) |
customer_name |
string |
customer_abbreviation |
string |
Retrieve a service account
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_project_service_accounts_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
created |
string (date-time) |
modified |
string (date-time) |
username |
string |
description |
string |
error_message |
string |
error_traceback |
string |
state |
any |
token |
string |
email |
string (email) |
expires_at |
string |
preferred_identifier |
string |
project |
string (uuid) |
project_uuid |
string (uuid) |
project_name |
string |
customer_uuid |
string (uuid) |
customer_name |
string |
customer_abbreviation |
string |
Create a project service account
Creates a new service account scoped to a specific project. This generates an API key that can be used for automated access to resources within that project.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
- Model Source:
ProjectServiceAccountRequest - API Source:
marketplace_project_service_accounts_create
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Field | Type | Required |
|---|---|---|
username |
string | |
description |
string | |
error_traceback |
string | |
email |
string (email) | |
preferred_identifier |
string | |
project |
string (uuid) | ✓ |
201 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
created |
string (date-time) |
modified |
string (date-time) |
username |
string |
description |
string |
error_message |
string |
error_traceback |
string |
state |
any |
token |
string |
email |
string (email) |
expires_at |
string |
preferred_identifier |
string |
project |
string (uuid) |
project_uuid |
string (uuid) |
project_name |
string |
customer_uuid |
string (uuid) |
customer_name |
string |
customer_abbreviation |
string |
Update a service account
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
ProjectServiceAccountRequest - API Source:
marketplace_project_service_accounts_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
username |
string | |
description |
string | |
error_traceback |
string | |
email |
string (email) | |
preferred_identifier |
string | |
project |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
created |
string (date-time) |
modified |
string (date-time) |
username |
string |
description |
string |
error_message |
string |
error_traceback |
string |
state |
any |
token |
string |
email |
string (email) |
expires_at |
string |
preferred_identifier |
string |
project |
string (uuid) |
project_uuid |
string (uuid) |
project_name |
string |
customer_uuid |
string (uuid) |
customer_name |
string |
customer_abbreviation |
string |
Partially update a service account
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedProjectServiceAccountRequest - API Source:
marketplace_project_service_accounts_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
username |
string | |
description |
string | |
error_traceback |
string | |
email |
string (email) | |
preferred_identifier |
string | |
project |
string (uuid) |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
created |
string (date-time) |
modified |
string (date-time) |
username |
string |
description |
string |
error_message |
string |
error_traceback |
string |
state |
any |
token |
string |
email |
string (email) |
expires_at |
string |
preferred_identifier |
string |
project |
string (uuid) |
project_uuid |
string (uuid) |
project_name |
string |
customer_uuid |
string (uuid) |
customer_name |
string |
customer_abbreviation |
string |
Close a project service account
Deactivates a project service account and revokes its API key.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_project_service_accounts_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
Rotate API key for a project service account
Generates a new API key for the service account, immediately invalidating the old one. The new key is returned in the response.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
created |
string (date-time) |
modified |
string (date-time) |
username |
string |
description |
string |
error_message |
string |
error_traceback |
string |
state |
any |
token |
string |
email |
string (email) |
expires_at |
string |
preferred_identifier |
string |
project |
string (uuid) |
project_uuid |
string (uuid) |
project_name |
string |
customer_uuid |
string (uuid) |
customer_name |
string |
customer_abbreviation |
string |
Marketplace Resource Users
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/marketplace-resource-users/ |
List resource users |
| GET | /api/marketplace-resource-users/{uuid}/ |
Retrieve a resource-user link |
| POST | /api/marketplace-resource-users/ |
Link a user to a resource |
| DELETE | /api/marketplace-resource-users/{uuid}/ |
Unlink a user from a resource |
List resource users
Returns a paginated list of users associated with resources, including their roles. The list is filtered based on the permissions of the current user. Staff and support users can see all resource-user links. Other users can only see links for resources they have access to.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
marketplace_resource_users_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
resource |
string (uri) | Resource URL |
resource_uuid |
string (uuid) | Resource UUID |
role_name |
string | Role name |
role_uuid |
string (uuid) | Role UUID |
user_uuid |
string (uuid) | User UUID |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
resource |
string (uri) | |
role |
string (uri) | |
user |
string (uri) | |
resource_uuid |
string (uuid) | |
role_uuid |
string (uuid) | |
user_uuid |
string (uuid) | |
resource_name |
string | |
role_name |
string | |
user_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
user_full_name |
string |
Retrieve a resource-user link
Returns details of a specific link between a user and a resource, including their role.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_resource_users_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
resource |
string (uri) | |
role |
string (uri) | |
user |
string (uri) | |
resource_uuid |
string (uuid) | |
role_uuid |
string (uuid) | |
user_uuid |
string (uuid) | |
resource_name |
string | |
role_name |
string | |
user_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
user_full_name |
string |
Link a user to a resource
Creates a new association between a user and a resource with a specific role. The user must have permission to manage users for the resource (typically service provider staff or owners).
1 2 3 4 5 6 7 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
ResourceUserRequest - API Source:
marketplace_resource_users_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
| Field | Type | Required |
|---|---|---|
resource |
string (uri) | ✓ |
role |
string (uri) | ✓ |
user |
string (uri) | ✓ |
201 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
resource |
string (uri) | |
role |
string (uri) | |
user |
string (uri) | |
resource_uuid |
string (uuid) | |
role_uuid |
string (uuid) | |
user_uuid |
string (uuid) | |
resource_name |
string | |
role_name |
string | |
user_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
user_full_name |
string |
Unlink a user from a resource
Removes the association between a user and a resource, effectively revoking their role on that resource. The user must have permission to manage users for the resource.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_resource_users_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Marketplace Robot Accounts
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/marketplace-robot-accounts/ |
List robot accounts |
| GET | /api/marketplace-robot-accounts/{uuid}/ |
Retrieve a robot account |
| POST | /api/marketplace-robot-accounts/ |
Create a robot account |
| PUT | /api/marketplace-robot-accounts/{uuid}/ |
Update a robot account |
| PATCH | /api/marketplace-robot-accounts/{uuid}/ |
Partially update a robot account |
| DELETE | /api/marketplace-robot-accounts/{uuid}/ |
Delete a robot account |
| Other Actions | ||
| POST | /api/marketplace-robot-accounts/{uuid}/set_state_creating/ |
Set robot account state to creating |
| POST | /api/marketplace-robot-accounts/{uuid}/set_state_deleted/ |
Set robot account state to deleted |
| POST | /api/marketplace-robot-accounts/{uuid}/set_state_erred/ |
Set robot account state to erred |
| POST | /api/marketplace-robot-accounts/{uuid}/set_state_ok/ |
Set robot account state to OK |
| POST | /api/marketplace-robot-accounts/{uuid}/set_state_request_deletion/ |
Request deletion of a robot account |
Core CRUD
List robot accounts
Returns a paginated list of robot accounts accessible to the current user.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- Model Source:
RemoteResourceSyncStatusRemoteStateEnum - Model Source:
RobotAccountDetailsFieldEnum - API Source:
marketplace_robot_accounts_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
created |
string (date-time) | Created after |
customer_uuid |
string (uuid) | Customer UUID |
field |
array | |
modified |
string (date-time) | Modified after |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
project_uuid |
string (uuid) | Project UUID |
provider_uuid |
string (uuid) | Provider UUID |
resource |
string (uri) | Resource URL |
resource_uuid |
string (uuid) | Resource UUID |
state |
integer | Robot account state Enum: 1, 2, 3, 4, 5, 6 |
type |
string |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
modified |
string (date-time) | |
username |
string | |
description |
string | |
error_message |
string | |
error_traceback |
string | |
state |
any | |
resource |
string (uri) | |
type |
string | Type of the robot account. |
users |
array of objects | |
users.url |
string (uri) | |
users.uuid |
string (uuid) | |
users.username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
users.full_name |
string | |
users.native_name |
string | |
users.email |
string (email) | |
users.image |
string (uri) | |
keys |
any | |
backend_id |
string | |
fingerprints |
array of objects | |
fingerprints.md5 |
string | MD5 fingerprint of SSH key |
fingerprints.sha256 |
string | SHA256 fingerprint of SSH key |
fingerprints.sha512 |
string | SHA512 fingerprint of SSH key |
responsible_user |
any | |
user_keys |
array of objects | |
user_keys.url |
string (uri) | |
user_keys.uuid |
string (uuid) | |
user_keys.name |
string | |
user_keys.public_key |
string | |
user_keys.fingerprint_md5 |
string | |
user_keys.fingerprint_sha256 |
string | |
user_keys.fingerprint_sha512 |
string | |
user_keys.user_uuid |
string (uuid) | |
user_keys.is_shared |
boolean | |
user_keys.type |
string | |
resource_name |
string | |
resource_uuid |
string (uuid) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
provider_uuid |
string (uuid) | |
provider_name |
string | |
offering_plugin_options |
any |
Retrieve a robot account
Returns the details of a specific robot account.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
RobotAccountDetailsFieldEnum - API Source:
marketplace_robot_accounts_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
modified |
string (date-time) | |
username |
string | |
description |
string | |
error_message |
string | |
error_traceback |
string | |
state |
any | |
resource |
string (uri) | |
type |
string | Type of the robot account. |
users |
array of objects | |
users.url |
string (uri) | |
users.uuid |
string (uuid) | |
users.username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
users.full_name |
string | |
users.native_name |
string | |
users.email |
string (email) | |
users.image |
string (uri) | |
keys |
any | |
backend_id |
string | |
fingerprints |
array of objects | |
fingerprints.md5 |
string | MD5 fingerprint of SSH key |
fingerprints.sha256 |
string | SHA256 fingerprint of SSH key |
fingerprints.sha512 |
string | SHA512 fingerprint of SSH key |
responsible_user |
any | |
user_keys |
array of objects | |
user_keys.url |
string (uri) | |
user_keys.uuid |
string (uuid) | |
user_keys.name |
string | |
user_keys.public_key |
string | |
user_keys.fingerprint_md5 |
string | |
user_keys.fingerprint_sha256 |
string | |
user_keys.fingerprint_sha512 |
string | |
user_keys.user_uuid |
string (uuid) | |
user_keys.is_shared |
boolean | |
user_keys.type |
string | |
resource_name |
string | |
resource_uuid |
string (uuid) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
provider_uuid |
string (uuid) | |
provider_name |
string | |
offering_plugin_options |
any |
Create a robot account
Creates a new robot account for a specific resource. This is typically used for automated access to a resource, e.g., for CI/CD pipelines.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
RobotAccountRequest - API Source:
marketplace_robot_accounts_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Field | Type | Required | Description |
|---|---|---|---|
username |
string | ||
description |
string | ||
resource |
string (uri) | ✓ | |
type |
string | ✓ | Type of the robot account. |
users |
array of string (uri)s | Users who have access to this robot account. | |
keys |
any | ||
responsible_user |
string (uri) |
201 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
modified |
string (date-time) | |
username |
string | |
description |
string | |
error_message |
string | |
error_traceback |
string | |
state |
any | |
resource |
string (uri) | |
type |
string | Type of the robot account. |
users |
array of string (uri)s | Users who have access to this robot account. |
keys |
any | |
backend_id |
string | |
fingerprints |
array of objects | |
fingerprints.md5 |
string | MD5 fingerprint of SSH key |
fingerprints.sha256 |
string | SHA256 fingerprint of SSH key |
fingerprints.sha512 |
string | SHA512 fingerprint of SSH key |
responsible_user |
string (uri) |
Update a robot account
Updates the properties of a robot account, such as its username or associated users. Not allowed for synchronized remote accounts.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
RobotAccountRequest - API Source:
marketplace_robot_accounts_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
username |
string | ||
description |
string | ||
resource |
string (uri) | ✓ | |
type |
string | ✓ | Type of the robot account. |
users |
array of string (uri)s | Users who have access to this robot account. | |
keys |
any | ||
responsible_user |
string (uri) |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
modified |
string (date-time) | |
username |
string | |
description |
string | |
error_message |
string | |
error_traceback |
string | |
state |
any | |
resource |
string (uri) | |
type |
string | Type of the robot account. |
users |
array of string (uri)s | Users who have access to this robot account. |
keys |
any | |
backend_id |
string | |
fingerprints |
array of objects | |
fingerprints.md5 |
string | MD5 fingerprint of SSH key |
fingerprints.sha256 |
string | SHA256 fingerprint of SSH key |
fingerprints.sha512 |
string | SHA512 fingerprint of SSH key |
responsible_user |
string (uri) |
Partially update a robot account
Partially updates the properties of a robot account. Not allowed for synchronized remote accounts.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedRobotAccountRequest - API Source:
marketplace_robot_accounts_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
username |
string | ||
description |
string | ||
resource |
string (uri) | ||
type |
string | Type of the robot account. | |
users |
array of string (uri)s | Users who have access to this robot account. | |
keys |
any | ||
responsible_user |
string (uri) |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
modified |
string (date-time) | |
username |
string | |
description |
string | |
error_message |
string | |
error_traceback |
string | |
state |
any | |
resource |
string (uri) | |
type |
string | Type of the robot account. |
users |
array of string (uri)s | Users who have access to this robot account. |
keys |
any | |
backend_id |
string | |
fingerprints |
array of objects | |
fingerprints.md5 |
string | MD5 fingerprint of SSH key |
fingerprints.sha256 |
string | SHA256 fingerprint of SSH key |
fingerprints.sha512 |
string | SHA512 fingerprint of SSH key |
responsible_user |
string (uri) |
Delete a robot account
Deletes a robot account. This is a hard delete and should be used with caution.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_robot_accounts_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
Set robot account state to creating
Transitions the robot account state from 'Requested' to 'Creating'. This is typically used by an agent to signal that the creation process has started.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_robot_accounts_set_state_creating
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
modified |
string (date-time) | |
username |
string | |
description |
string | |
error_message |
string | |
error_traceback |
string | |
state |
any | |
resource |
string (uri) | |
type |
string | Type of the robot account. |
users |
array of objects | |
users.url |
string (uri) | |
users.uuid |
string (uuid) | |
users.username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
users.full_name |
string | |
users.native_name |
string | |
users.email |
string (email) | |
users.image |
string (uri) | |
keys |
any | |
backend_id |
string | |
fingerprints |
array of objects | |
fingerprints.md5 |
string | MD5 fingerprint of SSH key |
fingerprints.sha256 |
string | SHA256 fingerprint of SSH key |
fingerprints.sha512 |
string | SHA512 fingerprint of SSH key |
responsible_user |
any | |
user_keys |
array of objects | |
user_keys.url |
string (uri) | |
user_keys.uuid |
string (uuid) | |
user_keys.name |
string | |
user_keys.public_key |
string | |
user_keys.fingerprint_md5 |
string | |
user_keys.fingerprint_sha256 |
string | |
user_keys.fingerprint_sha512 |
string | |
user_keys.user_uuid |
string (uuid) | |
user_keys.is_shared |
boolean | |
user_keys.type |
string | |
resource_name |
string | |
resource_uuid |
string (uuid) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
provider_uuid |
string (uuid) | |
provider_name |
string | |
offering_plugin_options |
any |
400 -
| Field | Type | Description |
|---|---|---|
detail |
string | Error message to be displayed to the user |
Set robot account state to deleted
Transitions the robot account state from 'Requested deletion' to 'Deleted', marking the successful completion of the deletion process.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_robot_accounts_set_state_deleted
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
modified |
string (date-time) | |
username |
string | |
description |
string | |
error_message |
string | |
error_traceback |
string | |
state |
any | |
resource |
string (uri) | |
type |
string | Type of the robot account. |
users |
array of objects | |
users.url |
string (uri) | |
users.uuid |
string (uuid) | |
users.username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
users.full_name |
string | |
users.native_name |
string | |
users.email |
string (email) | |
users.image |
string (uri) | |
keys |
any | |
backend_id |
string | |
fingerprints |
array of objects | |
fingerprints.md5 |
string | MD5 fingerprint of SSH key |
fingerprints.sha256 |
string | SHA256 fingerprint of SSH key |
fingerprints.sha512 |
string | SHA512 fingerprint of SSH key |
responsible_user |
any | |
user_keys |
array of objects | |
user_keys.url |
string (uri) | |
user_keys.uuid |
string (uuid) | |
user_keys.name |
string | |
user_keys.public_key |
string | |
user_keys.fingerprint_md5 |
string | |
user_keys.fingerprint_sha256 |
string | |
user_keys.fingerprint_sha512 |
string | |
user_keys.user_uuid |
string (uuid) | |
user_keys.is_shared |
boolean | |
user_keys.type |
string | |
resource_name |
string | |
resource_uuid |
string (uuid) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
provider_uuid |
string (uuid) | |
provider_name |
string | |
offering_plugin_options |
any |
400 -
| Field | Type | Description |
|---|---|---|
detail |
string | Error message to be displayed to the user |
Set robot account state to erred
Manually moves the robot account into the 'Error' state. An optional error message can be provided.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
RobotAccountErrorRequest - API Source:
marketplace_robot_accounts_set_state_erred
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
error_message |
string | Error message to be saved to the robot account |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
modified |
string (date-time) | |
username |
string | |
description |
string | |
error_message |
string | |
error_traceback |
string | |
state |
any | |
resource |
string (uri) | |
type |
string | Type of the robot account. |
users |
array of objects | |
users.url |
string (uri) | |
users.uuid |
string (uuid) | |
users.username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
users.full_name |
string | |
users.native_name |
string | |
users.email |
string (email) | |
users.image |
string (uri) | |
keys |
any | |
backend_id |
string | |
fingerprints |
array of objects | |
fingerprints.md5 |
string | MD5 fingerprint of SSH key |
fingerprints.sha256 |
string | SHA256 fingerprint of SSH key |
fingerprints.sha512 |
string | SHA512 fingerprint of SSH key |
responsible_user |
any | |
user_keys |
array of objects | |
user_keys.url |
string (uri) | |
user_keys.uuid |
string (uuid) | |
user_keys.name |
string | |
user_keys.public_key |
string | |
user_keys.fingerprint_md5 |
string | |
user_keys.fingerprint_sha256 |
string | |
user_keys.fingerprint_sha512 |
string | |
user_keys.user_uuid |
string (uuid) | |
user_keys.is_shared |
boolean | |
user_keys.type |
string | |
resource_name |
string | |
resource_uuid |
string (uuid) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
provider_uuid |
string (uuid) | |
provider_name |
string | |
offering_plugin_options |
any |
400 -
| Field | Type | Description |
|---|---|---|
detail |
string | Error message to be displayed to the user |
Set robot account state to OK
Manually sets the robot account state to 'OK', indicating that it is fully operational. This can be used to recover from an error state.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_robot_accounts_set_state_ok
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
modified |
string (date-time) | |
username |
string | |
description |
string | |
error_message |
string | |
error_traceback |
string | |
state |
any | |
resource |
string (uri) | |
type |
string | Type of the robot account. |
users |
array of objects | |
users.url |
string (uri) | |
users.uuid |
string (uuid) | |
users.username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
users.full_name |
string | |
users.native_name |
string | |
users.email |
string (email) | |
users.image |
string (uri) | |
keys |
any | |
backend_id |
string | |
fingerprints |
array of objects | |
fingerprints.md5 |
string | MD5 fingerprint of SSH key |
fingerprints.sha256 |
string | SHA256 fingerprint of SSH key |
fingerprints.sha512 |
string | SHA512 fingerprint of SSH key |
responsible_user |
any | |
user_keys |
array of objects | |
user_keys.url |
string (uri) | |
user_keys.uuid |
string (uuid) | |
user_keys.name |
string | |
user_keys.public_key |
string | |
user_keys.fingerprint_md5 |
string | |
user_keys.fingerprint_sha256 |
string | |
user_keys.fingerprint_sha512 |
string | |
user_keys.user_uuid |
string (uuid) | |
user_keys.is_shared |
boolean | |
user_keys.type |
string | |
resource_name |
string | |
resource_uuid |
string (uuid) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
provider_uuid |
string (uuid) | |
provider_name |
string | |
offering_plugin_options |
any |
400 -
| Field | Type | Description |
|---|---|---|
detail |
string | Error message to be displayed to the user |
Request deletion of a robot account
Transitions the robot account state from 'OK' to 'Requested deletion', initiating the deletion process.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
modified |
string (date-time) | |
username |
string | |
description |
string | |
error_message |
string | |
error_traceback |
string | |
state |
any | |
resource |
string (uri) | |
type |
string | Type of the robot account. |
users |
array of objects | |
users.url |
string (uri) | |
users.uuid |
string (uuid) | |
users.username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
users.full_name |
string | |
users.native_name |
string | |
users.email |
string (email) | |
users.image |
string (uri) | |
keys |
any | |
backend_id |
string | |
fingerprints |
array of objects | |
fingerprints.md5 |
string | MD5 fingerprint of SSH key |
fingerprints.sha256 |
string | SHA256 fingerprint of SSH key |
fingerprints.sha512 |
string | SHA512 fingerprint of SSH key |
responsible_user |
any | |
user_keys |
array of objects | |
user_keys.url |
string (uri) | |
user_keys.uuid |
string (uuid) | |
user_keys.name |
string | |
user_keys.public_key |
string | |
user_keys.fingerprint_md5 |
string | |
user_keys.fingerprint_sha256 |
string | |
user_keys.fingerprint_sha512 |
string | |
user_keys.user_uuid |
string (uuid) | |
user_keys.is_shared |
boolean | |
user_keys.type |
string | |
resource_name |
string | |
resource_uuid |
string (uuid) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
provider_uuid |
string (uuid) | |
provider_name |
string | |
offering_plugin_options |
any |
400 -
| Field | Type | Description |
|---|---|---|
detail |
string | Error message to be displayed to the user |
Marketplace User Offering Consents
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/marketplace-user-offering-consents/ |
List user offering consents |
| GET | /api/marketplace-user-offering-consents/{uuid}/ |
Retrieve a user offering consent |
| POST | /api/marketplace-user-offering-consents/ |
Grant consent to an offering's Terms of Service |
| PUT | /api/marketplace-user-offering-consents/{uuid}/ |
Update |
| PATCH | /api/marketplace-user-offering-consents/{uuid}/ |
Partial Update |
| DELETE | /api/marketplace-user-offering-consents/{uuid}/ |
Delete |
| Other Actions | ||
| POST | /api/marketplace-user-offering-consents/{uuid}/revoke/ |
Revoke consent to Terms of Service |
Core CRUD
List user offering consents
Returns a paginated list of Terms of Service consents for the current user. Staff and support users can see all consents.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 | |
- Model Source:
UserOfferingConsentOEnum - API Source:
marketplace_user_offering_consents_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
has_consent |
boolean | Has consent |
o |
array | Ordering |
offering |
string (uri) | Offering URL |
offering_uuid |
string (uuid) | Offering UUID |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
requires_reconsent |
boolean | Requires reconsent |
user |
string (uri) | User URL |
user_uuid |
string (uuid) | User UUID |
version |
string | Version |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
user_uuid |
string (uuid) | |
offering_uuid |
string (uuid) | |
agreement_date |
string (date-time) | |
version |
string | |
revocation_date |
string (date-time) | |
created |
string (date-time) | |
user_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
user_full_name |
string | |
user_email |
string (email) | |
offering_name |
string | |
offering_slug |
string | |
offering_url |
string (uri) | |
modified |
string (date-time) | |
has_consent |
boolean | |
requires_reconsent |
boolean | |
collected_attributes |
array of strings | List of user attributes that will be shared with service provider |
Retrieve a user offering consent
Returns the details of a specific consent record.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_user_offering_consents_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
user_uuid |
string (uuid) | |
offering_uuid |
string (uuid) | |
agreement_date |
string (date-time) | |
version |
string | |
revocation_date |
string (date-time) | |
created |
string (date-time) | |
user_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
user_full_name |
string | |
user_email |
string (email) | |
offering_name |
string | |
offering_slug |
string | |
offering_url |
string (uri) | |
modified |
string (date-time) | |
has_consent |
boolean | |
requires_reconsent |
boolean | |
collected_attributes |
array of strings | List of user attributes that will be shared with service provider |
Grant consent to an offering's Terms of Service
Creates a consent record for the current user and a specific offering. This indicates that the user has accepted the active Terms of Service for that offering. If a consent already exists (even if revoked), it will be reactivated and updated with the current ToS version.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
- Model Source:
UserOfferingConsentCreateRequest - API Source:
marketplace_user_offering_consents_create
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Field | Type | Required |
|---|---|---|
offering |
string (uuid) | ✓ |
201 -
| Field | Type |
|---|---|
offering |
string (uuid) |
Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
UserOfferingConsentRequest - API Source:
marketplace_user_offering_consents_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
version |
string |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
user_uuid |
string (uuid) | |
offering_uuid |
string (uuid) | |
agreement_date |
string (date-time) | |
version |
string | |
revocation_date |
string (date-time) | |
created |
string (date-time) | |
user_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
user_full_name |
string | |
user_email |
string (email) | |
offering_name |
string | |
offering_slug |
string | |
offering_url |
string (uri) | |
modified |
string (date-time) | |
has_consent |
boolean | |
requires_reconsent |
boolean | |
collected_attributes |
array of strings | List of user attributes that will be shared with service provider |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedUserOfferingConsentRequest - API Source:
marketplace_user_offering_consents_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
version |
string |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
user_uuid |
string (uuid) | |
offering_uuid |
string (uuid) | |
agreement_date |
string (date-time) | |
version |
string | |
revocation_date |
string (date-time) | |
created |
string (date-time) | |
user_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
user_full_name |
string | |
user_email |
string (email) | |
offering_name |
string | |
offering_slug |
string | |
offering_url |
string (uri) | |
modified |
string (date-time) | |
has_consent |
boolean | |
requires_reconsent |
boolean | |
collected_attributes |
array of strings | List of user attributes that will be shared with service provider |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_user_offering_consents_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
Revoke consent to Terms of Service
Revokes a user's consent to the Terms of Service for an offering. The consent record is marked with a revocation date, and the user may lose access to related resources if consent is required.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_user_offering_consents_revoke
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
user_uuid |
string (uuid) | |
offering_uuid |
string (uuid) | |
agreement_date |
string (date-time) | |
version |
string | |
revocation_date |
string (date-time) | |
created |
string (date-time) | |
user_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
user_full_name |
string | |
user_email |
string (email) | |
offering_name |
string | |
offering_slug |
string | |
offering_url |
string (uri) | |
modified |
string (date-time) | |
has_consent |
boolean | |
requires_reconsent |
boolean | |
collected_attributes |
array of strings | List of user attributes that will be shared with service provider |
Arrow
Admin Arrow Billing Sync Items
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/admin/arrow/billing-sync-items/ |
Billing sync items |
| GET | /api/admin/arrow/billing-sync-items/{uuid}/ |
Retrieve |
Billing sync items
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
admin_arrow_billing_sync_items_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
arrow_line_reference |
string | |
billing_sync |
string (uri) | |
billing_sync_uuid |
string (uuid) | |
classification |
string | |
has_compensation |
boolean | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
report_period |
string | |
subscription_reference |
string | |
vendor_name |
string |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
billing_sync |
string (uri) | |
billing_sync_uuid |
string (uuid) | |
report_period |
string | Report period in YYYY-MM format |
arrow_line_reference |
string | Arrow line ID |
invoice_item_uuid |
string (uuid) | |
original_price |
string (decimal) | Original price for reconciliation tracking |
compensation_item_uuid |
string (uuid) | |
has_compensation |
boolean | |
vendor_name |
string | Vendor name (e.g., Microsoft) |
subscription_reference |
string | Arrow subscription reference |
classification |
string | Classification (IAAS/SAAS) |
description |
string | Line item description |
quantity |
string (decimal) | Quantity |
created |
string (date-time) |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
admin_arrow_billing_sync_items_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
billing_sync |
string (uri) | |
billing_sync_uuid |
string (uuid) | |
report_period |
string | Report period in YYYY-MM format |
arrow_line_reference |
string | Arrow line ID |
invoice_item_uuid |
string (uuid) | |
original_price |
string (decimal) | Original price for reconciliation tracking |
compensation_item_uuid |
string (uuid) | |
has_compensation |
boolean | |
vendor_name |
string | Vendor name (e.g., Microsoft) |
subscription_reference |
string | Arrow subscription reference |
classification |
string | Classification (IAAS/SAAS) |
description |
string | Line item description |
quantity |
string (decimal) | Quantity |
created |
string (date-time) |
Admin Arrow Billing Syncs
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/admin/arrow/billing-syncs/ |
Billing syncs |
| GET | /api/admin/arrow/billing-syncs/{uuid}/ |
Retrieve |
| Sync Control | ||
| POST | /api/admin/arrow/billing-syncs/pause_sync/ |
Pause consumption sync operations |
| POST | /api/admin/arrow/billing-syncs/reconcile/ |
Trigger reconciliation for a specific period |
| POST | /api/admin/arrow/billing-syncs/resume_sync/ |
Resume consumption sync operations |
| POST | /api/admin/arrow/billing-syncs/trigger_consumption_sync/ |
Trigger consumption sync for a specific period |
| POST | /api/admin/arrow/billing-syncs/trigger_reconciliation/ |
Trigger reconciliation (check billing export and apply adjustments) |
| POST | /api/admin/arrow/billing-syncs/trigger_sync/ |
Trigger billing sync for a specific period |
| Data Retrieval | ||
| GET | /api/admin/arrow/billing-syncs/consumption_statistics/ |
Get consumption statistics |
| GET | /api/admin/arrow/billing-syncs/consumption_status/ |
Get current consumption sync status |
| GET | /api/admin/arrow/billing-syncs/pending_records/ |
List pending consumption records (not yet finalized) |
| POST | /api/admin/arrow/billing-syncs/fetch_billing_export/ |
Fetch raw billing export from Arrow API |
| POST | /api/admin/arrow/billing-syncs/fetch_consumption/ |
Fetch raw consumption data from Arrow API |
| POST | /api/admin/arrow/billing-syncs/fetch_license_info/ |
Fetch license details from Arrow API |
| POST | /api/admin/arrow/billing-syncs/sync_resource_historical_consumption/ |
Sync historical consumption for a specific resource from Arrow |
| POST | /api/admin/arrow/billing-syncs/sync_resources/ |
Sync resources |
| Cleanup | ||
| POST | /api/admin/arrow/billing-syncs/cleanup_consumption/ |
Delete consumption records with optional dry-run preview |
Core CRUD
Billing syncs
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
admin_arrow_billing_syncs_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
arrow_state |
string | |
customer_mapping |
string (uri) | |
customer_mapping_uuid |
string (uuid) | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
report_period |
string | |
report_period_from |
string | |
report_period_to |
string | |
settings_uuid |
string (uuid) | |
state |
integer | |
statement_reference |
string |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
customer_mapping |
string (uri) | |
customer_mapping_uuid |
string (uuid) | |
arrow_reference |
string | Arrow customer ID (e.g., 'XSP661245') |
waldur_customer_name |
string | |
statement_reference |
string | Arrow statement ID |
report_period |
string | Report period in YYYY-MM format |
arrow_state |
string | Arrow billing state (pending/validated) |
state |
any | Waldur sync state |
state_display |
string | |
buy_total |
string (decimal) | Total buy amount |
sell_total |
string (decimal) | Total sell amount |
currency |
string | Currency code |
invoice_uuid |
string (uuid) | |
error_message |
string | Error message if sync failed |
synced_at |
string (date-time) | When billing was last synced |
validated_at |
string (date-time) | When Arrow validated the billing |
reconciled_at |
string (date-time) | When reconciliation was applied |
items |
array of objects | |
items.uuid |
string (uuid) | |
items.arrow_line_reference |
string | Arrow line ID |
items.invoice_item_uuid |
string (uuid) | |
items.original_price |
string (decimal) | Original price for reconciliation tracking |
items.compensation_item_uuid |
string (uuid) | |
items.vendor_name |
string | Vendor name (e.g., Microsoft) |
items.subscription_reference |
string | Arrow subscription reference |
items.classification |
string | Classification (IAAS/SAAS) |
items.description |
string | Line item description |
items.quantity |
string (decimal) | Quantity |
items.created |
string (date-time) | |
created |
string (date-time) | |
modified |
string (date-time) |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
admin_arrow_billing_syncs_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
customer_mapping |
string (uri) | |
customer_mapping_uuid |
string (uuid) | |
arrow_reference |
string | Arrow customer ID (e.g., 'XSP661245') |
waldur_customer_name |
string | |
statement_reference |
string | Arrow statement ID |
report_period |
string | Report period in YYYY-MM format |
arrow_state |
string | Arrow billing state (pending/validated) |
state |
any | Waldur sync state |
state_display |
string | |
buy_total |
string (decimal) | Total buy amount |
sell_total |
string (decimal) | Total sell amount |
currency |
string | Currency code |
invoice_uuid |
string (uuid) | |
error_message |
string | Error message if sync failed |
synced_at |
string (date-time) | When billing was last synced |
validated_at |
string (date-time) | When Arrow validated the billing |
reconciled_at |
string (date-time) | When reconciliation was applied |
items |
array of objects | |
items.uuid |
string (uuid) | |
items.arrow_line_reference |
string | Arrow line ID |
items.invoice_item_uuid |
string (uuid) | |
items.original_price |
string (decimal) | Original price for reconciliation tracking |
items.compensation_item_uuid |
string (uuid) | |
items.vendor_name |
string | Vendor name (e.g., Microsoft) |
items.subscription_reference |
string | Arrow subscription reference |
items.classification |
string | Classification (IAAS/SAAS) |
items.description |
string | Line item description |
items.quantity |
string (decimal) | Quantity |
items.created |
string (date-time) | |
created |
string (date-time) | |
modified |
string (date-time) |
Sync Control
Pause consumption sync operations
Pause consumption sync operations.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
- Model Source:
SyncPauseRequestRequest - API Source:
admin_arrow_billing_syncs_pause_sync
1 2 3 4 5 6 7 8 9 10 | |
| Field | Type | Required |
|---|---|---|
settings_uuid |
string (uuid) | |
pause_global |
boolean |
200 -
| Field | Type | Description |
|---|---|---|
paused |
array of strings | List of paused items |
resumed |
array of strings | List of resumed items |
Trigger reconciliation for a specific period
Trigger reconciliation for a specific period.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
ReconcileRequestRequest - API Source:
admin_arrow_billing_syncs_reconcile
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Field | Type | Required | Description |
|---|---|---|---|
year |
integer | ✓ | |
month |
integer | ✓ | |
settings_uuid |
string (uuid) | ||
force |
boolean | Force reconciliation even if not validated Constraints: default: False |
202 - No response body
Resume consumption sync operations
Resume consumption sync operations.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
- Model Source:
SyncPauseRequestRequest - API Source:
admin_arrow_billing_syncs_resume_sync
1 2 3 4 5 6 7 8 9 10 | |
| Field | Type | Required |
|---|---|---|
settings_uuid |
string (uuid) | |
pause_global |
boolean |
200 -
| Field | Type | Description |
|---|---|---|
paused |
array of strings | List of paused items |
resumed |
array of strings | List of resumed items |
Trigger consumption sync for a specific period
Trigger consumption sync for a specific period.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
TriggerConsumptionSyncRequestRequest - API Source:
admin_arrow_billing_syncs_trigger_consumption_sync
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Field | Type | Required | Description |
|---|---|---|---|
year |
integer | ✓ | |
month |
integer | ✓ | |
settings_uuid |
string (uuid) | ||
resource_uuid |
string (uuid) | Sync specific resource only |
202 - No response body
Trigger reconciliation (check billing export and apply adjustments)
Trigger reconciliation (check billing export and apply adjustments).
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
ReconcileRequestRequest - API Source:
admin_arrow_billing_syncs_trigger_reconciliation
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Field | Type | Required | Description |
|---|---|---|---|
year |
integer | ✓ | |
month |
integer | ✓ | |
settings_uuid |
string (uuid) | ||
force |
boolean | Force reconciliation even if not validated Constraints: default: False |
202 - No response body
Trigger billing sync for a specific period
Trigger billing sync for a specific period.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
TriggerSyncRequestRequest - API Source:
admin_arrow_billing_syncs_trigger_sync
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Field | Type | Required | Description |
|---|---|---|---|
year |
integer | ✓ | |
month |
integer | ✓ | |
settings_uuid |
string (uuid) | ||
resource_uuid |
string (uuid) | If set, only sync billing lines for this resource. |
202 - No response body
Data Retrieval
Get consumption statistics
Get consumption statistics.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
1 2 3 4 5 6 7 8 9 10 | |
200 -
| Field | Type |
|---|---|
total_records |
integer |
pending_records |
integer |
finalized_records |
integer |
reconciled_records |
integer |
total_consumed_sell |
string (decimal) |
total_adjustments |
string (decimal) |
period_breakdown |
array of objects |
period_breakdown.period |
string |
period_breakdown.count |
integer |
period_breakdown.consumed_sell |
string (decimal) |
period_breakdown.finalized_count |
integer |
period_breakdown.reconciled_count |
integer |
Get current consumption sync status
Get current consumption sync status.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
1 2 3 4 5 6 7 8 9 10 | |
200 -
| Field | Type |
|---|---|
global_sync_enabled |
boolean |
settings_sync_enabled |
boolean |
settings_uuid |
string (uuid) |
last_sync_run |
string (date-time) |
List pending consumption records (not yet finalized)
List pending consumption records (not yet finalized).
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
admin_arrow_billing_syncs_pending_records_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
arrow_state |
string | |
customer_mapping |
string (uri) | |
customer_mapping_uuid |
string (uuid) | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
report_period |
string | |
report_period_from |
string | |
report_period_to |
string | |
settings_uuid |
string (uuid) | |
state |
integer | |
statement_reference |
string |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
uuid |
string (uuid) |
resource_uuid |
string (uuid) |
resource_name |
string |
license_reference |
string |
billing_period |
string (date) |
consumed_sell |
string (decimal) |
last_sync_at |
string (date-time) |
Fetch raw billing export from Arrow API
Fetch raw billing export from Arrow API.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
FetchBillingExportRequestRequest - API Source:
admin_arrow_billing_syncs_fetch_billing_export
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Field | Type | Required | Description |
|---|---|---|---|
period_from |
string | ✓ | YYYY-MM format |
period_to |
string | ✓ | YYYY-MM format |
classification |
string |
200 -
| Field | Type |
|---|---|
period_from |
string |
period_to |
string |
classification |
string |
row_count |
integer |
data |
array of objects |
Fetch raw consumption data from Arrow API
Fetch raw consumption data from Arrow API.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
FetchConsumptionRequestRequest - API Source:
admin_arrow_billing_syncs_fetch_consumption
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Field | Type | Required | Description |
|---|---|---|---|
license_reference |
string | ✓ | |
period |
string | ✓ | YYYY-MM format |
200 -
| Field | Type |
|---|---|
license_reference |
string |
period |
string |
row_count |
integer |
data |
array of objects |
Fetch license details from Arrow API
Fetch license details from Arrow API.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
- Model Source:
FetchLicenseInfoRequestRequest - API Source:
admin_arrow_billing_syncs_fetch_license_info
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Field | Type | Required |
|---|---|---|
license_reference |
string | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
data |
object (free-form) | Raw license data from Arrow API |
Sync historical consumption for a specific resource from Arrow
Sync historical consumption for a specific resource from Arrow.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Field | Type | Required | Description |
|---|---|---|---|
resource_uuid |
string (uuid) | ✓ | UUID of the resource to sync |
period_from |
string | Start period in YYYY-MM format. Defaults to 12 months ago. | |
period_to |
string | End period in YYYY-MM format. Defaults to current month. | |
force |
boolean | If True, sync even for finalized periods. Constraints: default: False |
|
dry_run |
boolean | If True, preview consumption data without saving. Constraints: default: False |
200 -
| Field | Type |
|---|---|
resource_uuid |
string (uuid) |
resource_name |
string |
periods_synced |
integer |
periods_skipped |
integer |
periods_no_data |
integer |
errors |
array of objects |
dry_run |
boolean |
preview_periods |
array of objects |
Sync resources
Sync Arrow IAAS subscriptions to Waldur Resources. Matches subscriptions by Vendor Subscription ID to resource backend_id. Updates resource report and current_usages fields. With force_import=True, auto-creates Customers and Projects from Arrow data.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
- Model Source:
SyncResourcesRequestRequest - API Source:
admin_arrow_billing_syncs_sync_resources
1 2 3 4 5 6 7 8 9 10 | |
| Field | Type | Required | Description |
|---|---|---|---|
period_from |
string | Start period in YYYY-MM format (default: 6 months ago, Arrow max) | |
period_to |
string | End period in YYYY-MM format (default: current month) | |
settings_uuid |
string (uuid) | ||
offering_uuid |
string (uuid) | Offering UUID for creating new resources | |
project_uuid |
string (uuid) | Project UUID for creating new resources (ignored if force_import=True) | |
force_import |
boolean | If True, auto-create Waldur Customers and Projects from Arrow data. Each Arrow customer gets a Waldur Customer with an 'Arrow Azure Subscriptions' project. Constraints: default: False |
200 -
| Field | Type |
|---|---|
synced |
integer |
created |
integer |
updated |
integer |
orders_created |
integer |
customers_created |
integer |
projects_created |
integer |
mappings_created |
integer |
invoices_created |
integer |
invoice_items_created |
integer |
errors |
array of objects |
Cleanup
Delete consumption records with optional dry-run preview
Delete consumption records with optional dry-run preview.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
- Model Source:
CleanupConsumptionRequestRequest - API Source:
admin_arrow_billing_syncs_cleanup_consumption
1 2 3 4 5 6 7 8 9 10 | |
| Field | Type | Required | Description |
|---|---|---|---|
period_from |
string | YYYY-MM format | |
period_to |
string | YYYY-MM format | |
resource_uuid |
string (uuid) | ||
only_finalized |
boolean | Constraints: default: False |
|
only_unfinalized |
boolean | Constraints: default: False |
|
dry_run |
boolean | Constraints: default: True |
200 -
| Field | Type |
|---|---|
dry_run |
boolean |
records_to_delete |
integer |
records_deleted |
integer |
compensation_items_affected |
integer |
invoice_items_affected |
integer |
Admin Arrow Consumption Records
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/admin/arrow/consumption-records/ |
Consumption records |
| GET | /api/admin/arrow/consumption-records/{uuid}/ |
Retrieve |
Consumption records
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
admin_arrow_consumption_records_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
billing_period |
string (date) | |
billing_period_from |
string (date) | |
billing_period_to |
string (date) | |
customer_uuid |
string (uuid) | |
is_finalized |
boolean | |
is_reconciled |
boolean | |
license_reference |
string | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
project_uuid |
string (uuid) | |
resource |
string (uri) | |
resource_uuid |
string (uuid) |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
resource |
string (uri) | |
resource_uuid |
string (uuid) | |
resource_name |
string | |
project_uuid |
string (uuid) | |
project_name |
string | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
license_reference |
string | Arrow license reference (e.g., 'XSP12345') |
billing_period |
string (date) | First day of the billing month |
consumed_sell |
string (decimal) | Consumed sell amount from Consumption API |
consumed_buy |
string (decimal) | Consumed buy amount from Consumption API |
final_sell |
string (decimal) | Final sell amount from billing export |
final_buy |
string (decimal) | Final buy amount from billing export |
invoice_item_uuid |
string (uuid) | |
compensation_item_uuid |
string (uuid) | |
last_sync_at |
string (date-time) | When consumption was last synced from API |
finalized_at |
string (date-time) | When billing export data arrived |
reconciled_at |
string (date-time) | When reconciliation was applied |
is_finalized |
boolean | |
is_reconciled |
boolean | |
adjustment_amount |
string (decimal) | |
raw_data |
any | Raw consumption data for debugging |
created |
string (date-time) | |
modified |
string (date-time) |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
admin_arrow_consumption_records_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
resource |
string (uri) | |
resource_uuid |
string (uuid) | |
resource_name |
string | |
project_uuid |
string (uuid) | |
project_name |
string | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
license_reference |
string | Arrow license reference (e.g., 'XSP12345') |
billing_period |
string (date) | First day of the billing month |
consumed_sell |
string (decimal) | Consumed sell amount from Consumption API |
consumed_buy |
string (decimal) | Consumed buy amount from Consumption API |
final_sell |
string (decimal) | Final sell amount from billing export |
final_buy |
string (decimal) | Final buy amount from billing export |
invoice_item_uuid |
string (uuid) | |
compensation_item_uuid |
string (uuid) | |
last_sync_at |
string (date-time) | When consumption was last synced from API |
finalized_at |
string (date-time) | When billing export data arrived |
reconciled_at |
string (date-time) | When reconciliation was applied |
is_finalized |
boolean | |
is_reconciled |
boolean | |
adjustment_amount |
string (decimal) | |
raw_data |
any | Raw consumption data for debugging |
created |
string (date-time) | |
modified |
string (date-time) |
Admin Arrow Customer Mappings
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/admin/arrow/customer-mappings/ |
Customer mappings |
| GET | /api/admin/arrow/customer-mappings/{uuid}/ |
Retrieve |
| Data Retrieval | ||
| GET | /api/admin/arrow/customer-mappings/available_customers/ |
Available customers |
| GET | /api/admin/arrow/customer-mappings/{uuid}/billing_summary/ |
Get billing and consumption summary for this customer mapping |
| GET | /api/admin/arrow/customer-mappings/{uuid}/discover_licenses/ |
Discover Arrow licenses for this customer and show linkable Waldur resources |
| GET | /api/admin/arrow/customer-mappings/{uuid}/fetch_arrow_data/ |
Fetch fresh consumption and billing data from Arrow API for this customer |
| Sync & Management | ||
| POST | /api/admin/arrow/customer-mappings/{uuid}/import_license/ |
Import an Arrow license as a new Waldur resource |
| POST | /api/admin/arrow/customer-mappings/{uuid}/link_resource/ |
Link a Waldur resource to an Arrow license by setting its backend_id |
| POST | /api/admin/arrow/customer-mappings/sync_from_arrow/ |
Sync customer list from Arrow and update arrow_company_name |
| Other Actions | ||
| POST | /api/admin/arrow/customer-mappings/ |
Customer mappings |
| PUT | /api/admin/arrow/customer-mappings/{uuid}/ |
Update |
| PATCH | /api/admin/arrow/customer-mappings/{uuid}/ |
Partial Update |
| DELETE | /api/admin/arrow/customer-mappings/{uuid}/ |
Delete |
Core CRUD
Customer mappings
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
admin_arrow_customer_mappings_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
arrow_company_name |
string | |
arrow_reference |
string | |
is_active |
boolean | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
settings |
string (uri) | |
settings_uuid |
string (uuid) | |
waldur_customer |
string (uri) | |
waldur_customer_uuid |
string (uuid) |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
settings |
string (uri) | |
settings_uuid |
string (uuid) | |
arrow_reference |
string | Arrow customer ID (e.g., 'XSP661245') |
arrow_company_name |
string | Arrow company name |
waldur_customer |
string (uri) | |
waldur_customer_uuid |
string (uuid) | |
waldur_customer_name |
string | |
is_active |
boolean | Whether this mapping is active |
created |
string (date-time) | |
modified |
string (date-time) |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
admin_arrow_customer_mappings_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
settings |
string (uri) | |
settings_uuid |
string (uuid) | |
arrow_reference |
string | Arrow customer ID (e.g., 'XSP661245') |
arrow_company_name |
string | Arrow company name |
waldur_customer |
string (uri) | |
waldur_customer_uuid |
string (uuid) | |
waldur_customer_name |
string | |
is_active |
boolean | Whether this mapping is active |
created |
string (date-time) | |
modified |
string (date-time) |
Data Retrieval
Available customers
Get available Arrow customers that are not yet mapped, with suggestions for Waldur organization matches.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
1 2 3 4 5 6 7 8 9 10 | |
200 -
| Field | Type |
|---|---|
settings_uuid |
string (uuid) |
arrow_customers |
array of objects |
arrow_customers.reference |
string |
arrow_customers.companyName |
string |
arrow_customers.email |
string |
arrow_customers.city |
string |
arrow_customers.countryCode |
string |
waldur_customers |
array of objects |
waldur_customers.uuid |
string (uuid) |
waldur_customers.name |
string |
waldur_customers.abbreviation |
string |
suggestions |
array of objects |
suggestions.arrow_customer |
object |
suggestions.arrow_customer.reference |
string |
suggestions.arrow_customer.companyName |
string |
suggestions.arrow_customer.email |
string |
suggestions.arrow_customer.city |
string |
suggestions.arrow_customer.countryCode |
string |
suggestions.suggested_waldur_customer |
object |
suggestions.suggested_waldur_customer.uuid |
string (uuid) |
suggestions.suggested_waldur_customer.name |
string |
suggestions.suggested_waldur_customer.abbreviation |
string |
suggestions.confidence |
number (double) |
suggestions.existing_mapping |
boolean |
Get billing and consumption summary for this customer mapping
Get billing and consumption summary for this customer mapping.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
customer_mapping_uuid |
string (uuid) |
arrow_reference |
string |
arrow_company_name |
string |
waldur_customer_uuid |
string (uuid) |
waldur_customer_name |
string |
total_consumption_records |
integer |
total_consumed_sell |
string (decimal) |
total_final_sell |
string (decimal) |
pending_records |
integer |
finalized_records |
integer |
reconciled_records |
integer |
total_billing_syncs |
integer |
total_billing_sell |
string (decimal) |
recent_consumption_records |
array of objects |
recent_consumption_records.uuid |
string (uuid) |
recent_consumption_records.license_reference |
string |
recent_consumption_records.resource_name |
string |
recent_consumption_records.billing_period |
string (date) |
recent_consumption_records.consumed_sell |
string (decimal) |
recent_consumption_records.final_sell |
string (decimal) |
recent_consumption_records.is_finalized |
boolean |
recent_consumption_records.is_reconciled |
boolean |
recent_billing_syncs |
array of objects |
recent_billing_syncs.uuid |
string (uuid) |
recent_billing_syncs.report_period |
string |
recent_billing_syncs.state |
string |
recent_billing_syncs.sell_total |
string (decimal) |
recent_billing_syncs.items_count |
integer |
recent_billing_syncs.created |
string (date-time) |
Discover Arrow licenses for this customer and show linkable Waldur resources
Discover Arrow licenses for this customer and show linkable Waldur resources.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
customer_mapping_uuid |
string (uuid) | |
arrow_reference |
string | |
waldur_customer_name |
string | |
arrow_licenses |
array of objects | Arrow licenses from billing export for this customer. |
arrow_licenses.license_reference |
string | Arrow license reference (e.g., XSP12345). Use this as resource backend_id. |
arrow_licenses.vendor_name |
string | |
arrow_licenses.offer_name |
string | |
arrow_licenses.offer_sku |
string | |
arrow_licenses.friendly_name |
string | |
waldur_resources |
array of objects | Waldur resources for this customer. |
waldur_resources.uuid |
string (uuid) | |
waldur_resources.name |
string | |
waldur_resources.backend_id |
string | Current backend_id (Arrow license reference if linked). |
waldur_resources.project_name |
string | |
waldur_resources.offering_name |
string | |
waldur_resources.state |
string | |
suggestions |
array of objects | Suggested matches based on name similarity. |
suggestions.resource_uuid |
string (uuid) | |
suggestions.resource_name |
string | |
suggestions.license_reference |
string | |
suggestions.license_name |
string | |
suggestions.confidence |
number (double) | Confidence score (0-1) based on name similarity. |
error |
string |
Fetch fresh consumption and billing data from Arrow API for this customer
Fetch fresh consumption and billing data from Arrow API for this customer.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
customer_mapping_uuid |
string (uuid) | |
arrow_reference |
string | |
arrow_company_name |
string | |
waldur_customer_name |
string | |
period |
string | |
billing_available |
boolean | |
billing_lines |
array of objects | |
billing_lines.vendor_name |
string | |
billing_lines.subscription_reference |
string | |
billing_lines.license_reference |
string | Arrow license reference. Used to fetch consumption data. |
billing_lines.offer_sku |
string | |
billing_lines.classification |
string | |
billing_lines.quantity |
string (decimal) | |
billing_lines.sell_price |
string (decimal) | |
billing_lines.buy_price |
string (decimal) | |
billing_total_sell |
string (decimal) | |
billing_total_buy |
string (decimal) | |
consumption_lines |
array of objects | |
consumption_lines.license_reference |
string | Arrow license reference (same as resource backend_id). |
consumption_lines.resource_name |
string | |
consumption_lines.resource_uuid |
string | UUID of the Waldur resource. |
consumption_lines.period |
string | |
consumption_lines.sell_price |
string (decimal) | |
consumption_lines.buy_price |
string (decimal) | |
consumption_lines.error |
string | Error message if fetch failed. |
consumption_total_sell |
string (decimal) | |
consumption_total_buy |
string (decimal) | |
total_customer_resources |
integer | Total number of resources for this customer in Waldur. |
resources_with_backend_id |
integer | Number of resources with backend_id set (Arrow license reference). |
matched_resources |
integer | Number of resources for which consumption was successfully fetched. |
error |
string |
Sync & Management
Import an Arrow license as a new Waldur resource
Import an Arrow license as a new Waldur resource.
1 2 3 4 5 6 7 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | |
- Model Source:
ImportLicenseRequestRequest - API Source:
admin_arrow_customer_mappings_import_license
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
license_reference |
string | ✓ | Arrow license reference (e.g., XSP12345). Will be set as backend_id. |
license_name |
string | Name for the new resource. Defaults to license_reference if not provided. | |
offering_uuid |
string (uuid) | ✓ | UUID of the Waldur offering to create the resource under. |
project_uuid |
string (uuid) | ✓ | UUID of the project to create the resource in. |
200 -
| Field | Type |
|---|---|
resource_uuid |
string (uuid) |
resource_name |
string |
license_reference |
string |
offering_name |
string |
project_name |
string |
success |
boolean |
Link a Waldur resource to an Arrow license by setting its backend_id
Link a Waldur resource to an Arrow license by setting its backend_id.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
LinkResourceRequestRequest - API Source:
admin_arrow_customer_mappings_link_resource
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
resource_uuid |
string (uuid) | ✓ | UUID of the Waldur resource to link. |
license_reference |
string | ✓ | Arrow license reference to set as backend_id (e.g., XSP12345). |
200 -
| Field | Type |
|---|---|
resource_uuid |
string (uuid) |
resource_name |
string |
license_reference |
string |
previous_backend_id |
string |
success |
boolean |
Sync customer list from Arrow and update arrow_company_name
Sync customer list from Arrow and update arrow_company_name.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
- Model Source:
SyncFromArrowRequestRequest - API Source:
admin_arrow_customer_mappings_sync_from_arrow
1 2 3 4 5 6 7 8 9 10 | |
| Field | Type | Required |
|---|---|---|
settings_uuid |
string (uuid) |
200 - No response body
Other Actions
Customer mappings
1 2 3 4 5 6 7 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
ArrowCustomerMappingCreateRequest - API Source:
admin_arrow_customer_mappings_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
| Field | Type | Required | Description |
|---|---|---|---|
settings |
string (uuid) | ✓ | |
arrow_reference |
string | ✓ | Arrow customer ID (e.g., 'XSP661245') |
arrow_company_name |
string | Arrow company name | |
waldur_customer |
string (uuid) | ✓ | |
is_active |
boolean | Whether this mapping is active |
201 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
settings |
string (uuid) | |
settings_uuid |
string (uuid) | |
arrow_reference |
string | Arrow customer ID (e.g., 'XSP661245') |
arrow_company_name |
string | Arrow company name |
waldur_customer |
string (uuid) | |
waldur_customer_uuid |
string (uuid) | |
waldur_customer_name |
string | |
is_active |
boolean | Whether this mapping is active |
created |
string (date-time) | |
modified |
string (date-time) |
Update
1 2 3 4 5 6 7 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | |
- Model Source:
ArrowCustomerMappingRequest - API Source:
admin_arrow_customer_mappings_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
settings |
string (uri) | ✓ | |
arrow_reference |
string | ✓ | Arrow customer ID (e.g., 'XSP661245') |
arrow_company_name |
string | Arrow company name | |
waldur_customer |
string (uri) | ✓ | |
is_active |
boolean | Whether this mapping is active |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
settings |
string (uri) | |
settings_uuid |
string (uuid) | |
arrow_reference |
string | Arrow customer ID (e.g., 'XSP661245') |
arrow_company_name |
string | Arrow company name |
waldur_customer |
string (uri) | |
waldur_customer_uuid |
string (uuid) | |
waldur_customer_name |
string | |
is_active |
boolean | Whether this mapping is active |
created |
string (date-time) | |
modified |
string (date-time) |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedArrowCustomerMappingRequest - API Source:
admin_arrow_customer_mappings_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
settings |
string (uri) | ||
arrow_reference |
string | Arrow customer ID (e.g., 'XSP661245') | |
arrow_company_name |
string | Arrow company name | |
waldur_customer |
string (uri) | ||
is_active |
boolean | Whether this mapping is active |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
settings |
string (uri) | |
settings_uuid |
string (uuid) | |
arrow_reference |
string | Arrow customer ID (e.g., 'XSP661245') |
arrow_company_name |
string | Arrow company name |
waldur_customer |
string (uri) | |
waldur_customer_uuid |
string (uuid) | |
waldur_customer_name |
string | |
is_active |
boolean | Whether this mapping is active |
created |
string (date-time) | |
modified |
string (date-time) |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
admin_arrow_customer_mappings_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Admin Arrow Settings
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/admin/arrow/settings/ |
List Admin Arrow Settings |
| GET | /api/admin/arrow/settings/{uuid}/ |
Retrieve |
| Management | ||
| POST | /api/admin/arrow/settings/discover_customers/ |
Discover Arrow customers and suggest mappings to Waldur customers |
| POST | /api/admin/arrow/settings/preview_settings/ |
Preview settings configuration before saving |
| POST | /api/admin/arrow/settings/save_settings/ |
Save Arrow settings and customer mappings |
| POST | /api/admin/arrow/settings/validate_credentials/ |
Validate Arrow API credentials without saving them |
| Other Actions | ||
| POST | /api/admin/arrow/settings/ |
Create |
| PUT | /api/admin/arrow/settings/{uuid}/ |
Update |
| PATCH | /api/admin/arrow/settings/{uuid}/ |
Partial Update |
| DELETE | /api/admin/arrow/settings/{uuid}/ |
Delete |
Core CRUD
List Admin Arrow Settings
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
admin_arrow_settings_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
is_active |
boolean | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
sync_enabled |
boolean |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
api_url |
string (uri) | Arrow API base URL |
api_key |
string | Arrow API Key (leave empty on update to keep current) |
export_type_reference |
string | Billing export template reference |
classification_filter |
string | Filter for IaaS/SaaS classification |
is_active |
boolean | Whether this settings record is active |
sync_enabled |
boolean | Whether automatic billing sync is enabled |
partner_reference |
string | Arrow partner reference (discovered from API) |
partner_name |
string | Arrow partner name (discovered from API) |
invoice_price_source |
any | Which price to use for invoice items: sell or buy |
invoice_item_prefix |
string | Prefix for invoice item names (e.g. 'Arrow consumption') |
created |
string (date-time) | |
modified |
string (date-time) |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
admin_arrow_settings_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
api_url |
string (uri) | Arrow API base URL |
api_key |
string | Arrow API Key (leave empty on update to keep current) |
export_type_reference |
string | Billing export template reference |
classification_filter |
string | Filter for IaaS/SaaS classification |
is_active |
boolean | Whether this settings record is active |
sync_enabled |
boolean | Whether automatic billing sync is enabled |
partner_reference |
string | Arrow partner reference (discovered from API) |
partner_name |
string | Arrow partner name (discovered from API) |
invoice_price_source |
any | Which price to use for invoice items: sell or buy |
invoice_item_prefix |
string | Prefix for invoice item names (e.g. 'Arrow consumption') |
created |
string (date-time) | |
modified |
string (date-time) |
Management
Discover Arrow customers and suggest mappings to Waldur customers
Discover Arrow customers and suggest mappings to Waldur customers.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
DiscoverCustomersRequestRequest - API Source:
admin_arrow_settings_discover_customers
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Field | Type | Required | Description |
|---|---|---|---|
api_url |
string (uri) | ✓ | Arrow API base URL |
api_key |
string | ✓ | Arrow API Key |
200 -
| Field | Type |
|---|---|
arrow_customers |
array of objects |
arrow_customers.reference |
string |
arrow_customers.companyName |
string |
arrow_customers.email |
string |
arrow_customers.city |
string |
arrow_customers.countryCode |
string |
waldur_customers |
array of objects |
waldur_customers.uuid |
string (uuid) |
waldur_customers.name |
string |
waldur_customers.abbreviation |
string |
suggestions |
array of objects |
suggestions.arrow_customer |
object |
suggestions.arrow_customer.reference |
string |
suggestions.arrow_customer.companyName |
string |
suggestions.arrow_customer.email |
string |
suggestions.arrow_customer.city |
string |
suggestions.arrow_customer.countryCode |
string |
suggestions.suggested_waldur_customer |
object |
suggestions.suggested_waldur_customer.uuid |
string (uuid) |
suggestions.suggested_waldur_customer.name |
string |
suggestions.suggested_waldur_customer.abbreviation |
string |
suggestions.confidence |
number (double) |
suggestions.existing_mapping |
boolean |
export_types |
array of objects |
export_types.reference |
string |
export_types.name |
string |
export_types.required_fields_total |
integer |
export_types.required_fields_found |
integer |
export_types.important_fields_total |
integer |
export_types.important_fields_found |
integer |
export_types.missing_required_fields |
array of strings |
export_types.missing_important_fields |
array of strings |
export_types.compatible |
boolean |
export_types.recommended |
boolean |
Preview settings configuration before saving
Preview settings configuration before saving.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
PreviewSettingsRequestRequest - API Source:
admin_arrow_settings_preview_settings
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Field | Type | Required | Description |
|---|---|---|---|
api_url |
string (uri) | ✓ | Arrow API base URL |
api_key |
string | ✓ | Arrow API Key |
export_type_reference |
string | ||
classification_filter |
string | Constraints: default: IAAS |
|
sync_enabled |
boolean | Constraints: default: False |
200 -
| Field | Type |
|---|---|
api_url |
string (uri) |
partner_name |
string |
partner_reference |
string |
export_type_reference |
string |
classification_filter |
string |
sync_enabled |
boolean |
Save Arrow settings and customer mappings
Save Arrow settings and customer mappings.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
SaveSettingsRequestRequest - API Source:
admin_arrow_settings_save_settings
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Field | Type | Required | Description |
|---|---|---|---|
api_url |
string (uri) | ✓ | Arrow API base URL |
api_key |
string | ✓ | Arrow API Key |
export_type_reference |
string | ||
classification_filter |
string | Constraints: default: IAAS |
|
sync_enabled |
boolean | Constraints: default: False |
|
customer_mappings |
array of objects | ||
customer_mappings.arrow_reference |
string | ✓ | |
customer_mappings.waldur_customer_uuid |
string (uuid) | ✓ |
201 -
| Field | Type |
|---|---|
settings_uuid |
string (uuid) |
mappings_created |
integer |
message |
string |
Validate Arrow API credentials without saving them
Validate Arrow API credentials without saving them.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
ArrowCredentialsRequest - API Source:
admin_arrow_settings_validate_credentials
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Field | Type | Required | Description |
|---|---|---|---|
api_url |
string (uri) | ✓ | Arrow API base URL |
api_key |
string | ✓ | Arrow API Key |
200 -
| Field | Type |
|---|---|
valid |
boolean |
message |
string |
error |
string |
partner_info |
object (free-form) |
Other Actions
Create
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
ArrowSettingsCreateRequest - API Source:
admin_arrow_settings_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Field | Type | Required | Description |
|---|---|---|---|
api_url |
string (uri) | ✓ | Arrow API base URL |
api_key |
string | ✓ | Arrow API Key (required for creation) Constraints: write-only |
export_type_reference |
string | Billing export template reference | |
classification_filter |
string | Filter for IaaS/SaaS classification | |
is_active |
boolean | Whether this settings record is active | |
sync_enabled |
boolean | Whether automatic billing sync is enabled | |
invoice_price_source |
any | Which price to use for invoice items: sell or buy | |
invoice_item_prefix |
string | Prefix for invoice item names (e.g. 'Arrow consumption') |
201 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
api_url |
string (uri) | Arrow API base URL |
export_type_reference |
string | Billing export template reference |
classification_filter |
string | Filter for IaaS/SaaS classification |
is_active |
boolean | Whether this settings record is active |
sync_enabled |
boolean | Whether automatic billing sync is enabled |
partner_reference |
string | Arrow partner reference (discovered from API) |
partner_name |
string | Arrow partner name (discovered from API) |
invoice_price_source |
any | Which price to use for invoice items: sell or buy |
invoice_item_prefix |
string | Prefix for invoice item names (e.g. 'Arrow consumption') |
created |
string (date-time) | |
modified |
string (date-time) |
Update
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
ArrowSettingsRequest - API Source:
admin_arrow_settings_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
api_url |
string (uri) | ✓ | Arrow API base URL |
api_key |
string | Arrow API Key (leave empty on update to keep current) | |
export_type_reference |
string | Billing export template reference | |
classification_filter |
string | Filter for IaaS/SaaS classification | |
is_active |
boolean | Whether this settings record is active | |
sync_enabled |
boolean | Whether automatic billing sync is enabled | |
invoice_price_source |
any | Which price to use for invoice items: sell or buy | |
invoice_item_prefix |
string | Prefix for invoice item names (e.g. 'Arrow consumption') |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
api_url |
string (uri) | Arrow API base URL |
api_key |
string | Arrow API Key (leave empty on update to keep current) |
export_type_reference |
string | Billing export template reference |
classification_filter |
string | Filter for IaaS/SaaS classification |
is_active |
boolean | Whether this settings record is active |
sync_enabled |
boolean | Whether automatic billing sync is enabled |
partner_reference |
string | Arrow partner reference (discovered from API) |
partner_name |
string | Arrow partner name (discovered from API) |
invoice_price_source |
any | Which price to use for invoice items: sell or buy |
invoice_item_prefix |
string | Prefix for invoice item names (e.g. 'Arrow consumption') |
created |
string (date-time) | |
modified |
string (date-time) |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedArrowSettingsRequest - API Source:
admin_arrow_settings_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
api_url |
string (uri) | Arrow API base URL | |
api_key |
string | Arrow API Key (leave empty on update to keep current) | |
export_type_reference |
string | Billing export template reference | |
classification_filter |
string | Filter for IaaS/SaaS classification | |
is_active |
boolean | Whether this settings record is active | |
sync_enabled |
boolean | Whether automatic billing sync is enabled | |
invoice_price_source |
any | Which price to use for invoice items: sell or buy | |
invoice_item_prefix |
string | Prefix for invoice item names (e.g. 'Arrow consumption') |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
api_url |
string (uri) | Arrow API base URL |
api_key |
string | Arrow API Key (leave empty on update to keep current) |
export_type_reference |
string | Billing export template reference |
classification_filter |
string | Filter for IaaS/SaaS classification |
is_active |
boolean | Whether this settings record is active |
sync_enabled |
boolean | Whether automatic billing sync is enabled |
partner_reference |
string | Arrow partner reference (discovered from API) |
partner_name |
string | Arrow partner name (discovered from API) |
invoice_price_source |
any | Which price to use for invoice items: sell or buy |
invoice_item_prefix |
string | Prefix for invoice item names (e.g. 'Arrow consumption') |
created |
string (date-time) | |
modified |
string (date-time) |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
admin_arrow_settings_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Admin Arrow Vendor Offering Mappings
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/admin/arrow/vendor-offering-mappings/ |
Vendor offering mappings |
| GET | /api/admin/arrow/vendor-offering-mappings/{uuid}/ |
Retrieve |
| Data | ||
| GET | /api/admin/arrow/vendor-offering-mappings/vendor_choices/ |
Get vendor names from Arrow catalog API (IAAS category) |
| Other Actions | ||
| POST | /api/admin/arrow/vendor-offering-mappings/ |
Vendor offering mappings |
| PUT | /api/admin/arrow/vendor-offering-mappings/{uuid}/ |
Update |
| PATCH | /api/admin/arrow/vendor-offering-mappings/{uuid}/ |
Partial Update |
| DELETE | /api/admin/arrow/vendor-offering-mappings/{uuid}/ |
Delete |
Core CRUD
Vendor offering mappings
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
admin_arrow_vendor_offering_mappings_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
arrow_vendor_name |
string | |
is_active |
boolean | |
offering |
string (uri) | |
offering_uuid |
string (uuid) | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
settings |
string (uri) | |
settings_uuid |
string (uuid) |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
settings |
string (uri) | |
settings_uuid |
string (uuid) | |
arrow_vendor_name |
string | Arrow vendor name (e.g., 'Microsoft', 'Amazon Web Services') |
offering |
string (uuid) | |
offering_uuid |
string (uuid) | |
offering_name |
string | |
offering_type |
string | |
plan |
string (uuid) | |
plan_uuid |
string (uuid) | |
plan_name |
string | |
is_active |
boolean | Whether this mapping is active |
created |
string (date-time) | |
modified |
string (date-time) |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
admin_arrow_vendor_offering_mappings_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
settings |
string (uri) | |
settings_uuid |
string (uuid) | |
arrow_vendor_name |
string | Arrow vendor name (e.g., 'Microsoft', 'Amazon Web Services') |
offering |
string (uuid) | |
offering_uuid |
string (uuid) | |
offering_name |
string | |
offering_type |
string | |
plan |
string (uuid) | |
plan_uuid |
string (uuid) | |
plan_name |
string | |
is_active |
boolean | Whether this mapping is active |
created |
string (date-time) | |
modified |
string (date-time) |
Data
Get vendor names from Arrow catalog API (IAAS category)
Get vendor names from Arrow catalog API (IAAS category).
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
arrow_vendor_name |
string | |
is_active |
boolean | |
offering |
string (uri) | |
offering_uuid |
string (uuid) | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
settings |
string (uri) | |
settings_uuid |
string (uuid) |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
value |
string |
label |
string |
Other Actions
Vendor offering mappings
1 2 3 4 5 6 7 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
ArrowVendorOfferingMappingCreateRequest - API Source:
admin_arrow_vendor_offering_mappings_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
| Field | Type | Required | Description |
|---|---|---|---|
settings |
string (uuid) | ✓ | |
arrow_vendor_name |
string | ✓ | Arrow vendor name (e.g., 'Microsoft', 'Amazon Web Services') |
offering |
string (uuid) | ✓ | |
plan |
string (uuid) | ||
is_active |
boolean | Whether this mapping is active |
201 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
settings |
string (uuid) | |
settings_uuid |
string (uuid) | |
arrow_vendor_name |
string | Arrow vendor name (e.g., 'Microsoft', 'Amazon Web Services') |
offering |
string (uuid) | |
offering_uuid |
string (uuid) | |
offering_name |
string | |
offering_type |
string | |
plan |
string (uuid) | |
plan_uuid |
string (uuid) | |
plan_name |
string | |
is_active |
boolean | Whether this mapping is active |
created |
string (date-time) | |
modified |
string (date-time) |
Update
1 2 3 4 5 6 7 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | |
- Model Source:
ArrowVendorOfferingMappingRequest - API Source:
admin_arrow_vendor_offering_mappings_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
settings |
string (uri) | ✓ | |
arrow_vendor_name |
string | ✓ | Arrow vendor name (e.g., 'Microsoft', 'Amazon Web Services') |
offering |
string (uuid) | ✓ | |
plan |
string (uuid) | ||
is_active |
boolean | Whether this mapping is active |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
settings |
string (uri) | |
settings_uuid |
string (uuid) | |
arrow_vendor_name |
string | Arrow vendor name (e.g., 'Microsoft', 'Amazon Web Services') |
offering |
string (uuid) | |
offering_uuid |
string (uuid) | |
offering_name |
string | |
offering_type |
string | |
plan |
string (uuid) | |
plan_uuid |
string (uuid) | |
plan_name |
string | |
is_active |
boolean | Whether this mapping is active |
created |
string (date-time) | |
modified |
string (date-time) |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedArrowVendorOfferingMappingRequest - API Source:
admin_arrow_vendor_offering_mappings_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
settings |
string (uri) | ||
arrow_vendor_name |
string | Arrow vendor name (e.g., 'Microsoft', 'Amazon Web Services') | |
offering |
string (uuid) | ||
plan |
string (uuid) | ||
is_active |
boolean | Whether this mapping is active |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
settings |
string (uri) | |
settings_uuid |
string (uuid) | |
arrow_vendor_name |
string | Arrow vendor name (e.g., 'Microsoft', 'Amazon Web Services') |
offering |
string (uuid) | |
offering_uuid |
string (uuid) | |
offering_name |
string | |
offering_type |
string | |
plan |
string (uuid) | |
plan_uuid |
string (uuid) | |
plan_name |
string | |
is_active |
boolean | Whether this mapping is active |
created |
string (date-time) | |
modified |
string (date-time) |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
admin_arrow_vendor_offering_mappings_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Automation
Autoprovisioning Rules
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/autoprovisioning-rules/ |
Manage autoprovisioning rules |
| GET | /api/autoprovisioning-rules/{uuid}/ |
Manage autoprovisioning rules |
| POST | /api/autoprovisioning-rules/ |
Manage autoprovisioning rules |
| PUT | /api/autoprovisioning-rules/{uuid}/ |
Manage autoprovisioning rules |
| PATCH | /api/autoprovisioning-rules/{uuid}/ |
Manage autoprovisioning rules |
| DELETE | /api/autoprovisioning-rules/{uuid}/ |
Manage autoprovisioning rules |
Manage autoprovisioning rules
Manage autoprovisioning rules.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
autoprovisioning_rules_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
name |
string |
uuid |
string (uuid) |
url |
string (uri) |
user_affiliations |
array of strings |
user_email_patterns |
array of strings |
customer |
string (uri) |
customer_name |
string |
customer_uuid |
string |
use_user_organization_as_customer_name |
boolean |
project_role |
string (uri) |
project_role_display_name |
string |
project_role_description |
string |
plan |
string (uri) |
plan_attributes |
object (free-form) |
plan_limits |
object (free-form) |
plan_name |
string |
offering_name |
string |
offering_uuid |
string (uuid) |
category_title |
string |
category_url |
string (uri) |
Manage autoprovisioning rules
Manage autoprovisioning rules.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
autoprovisioning_rules_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
name |
string |
uuid |
string (uuid) |
url |
string (uri) |
user_affiliations |
array of strings |
user_email_patterns |
array of strings |
customer |
string (uri) |
customer_name |
string |
customer_uuid |
string |
use_user_organization_as_customer_name |
boolean |
project_role |
string (uri) |
project_role_display_name |
string |
project_role_description |
string |
plan |
string (uri) |
plan_attributes |
object (free-form) |
plan_limits |
object (free-form) |
plan_name |
string |
offering_name |
string |
offering_uuid |
string (uuid) |
category_title |
string |
category_url |
string (uri) |
Manage autoprovisioning rules
Manage autoprovisioning rules.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
- Model Source:
RuleRequest - API Source:
autoprovisioning_rules_create
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Field | Type | Required |
|---|---|---|
name |
string | ✓ |
user_affiliations |
array of strings | |
user_email_patterns |
array of strings | |
customer |
string (uri) | |
use_user_organization_as_customer_name |
boolean | |
project_role |
string (uri) | |
project_role_name |
string | |
plan |
string (uri) | |
plan_attributes |
object (free-form) | |
plan_limits |
object (free-form) |
201 -
| Field | Type |
|---|---|
name |
string |
uuid |
string (uuid) |
url |
string (uri) |
user_affiliations |
array of strings |
user_email_patterns |
array of strings |
customer |
string (uri) |
customer_name |
string |
customer_uuid |
string |
use_user_organization_as_customer_name |
boolean |
project_role |
string (uri) |
project_role_display_name |
string |
project_role_description |
string |
plan |
string (uri) |
plan_attributes |
object (free-form) |
plan_limits |
object (free-form) |
plan_name |
string |
offering_name |
string |
offering_uuid |
string (uuid) |
category_title |
string |
category_url |
string (uri) |
Manage autoprovisioning rules
Manage autoprovisioning rules.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
RuleRequest - API Source:
autoprovisioning_rules_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
name |
string | ✓ |
user_affiliations |
array of strings | |
user_email_patterns |
array of strings | |
customer |
string (uri) | |
use_user_organization_as_customer_name |
boolean | |
project_role |
string (uri) | |
project_role_name |
string | |
plan |
string (uri) | |
plan_attributes |
object (free-form) | |
plan_limits |
object (free-form) |
200 -
| Field | Type |
|---|---|
name |
string |
uuid |
string (uuid) |
url |
string (uri) |
user_affiliations |
array of strings |
user_email_patterns |
array of strings |
customer |
string (uri) |
customer_name |
string |
customer_uuid |
string |
use_user_organization_as_customer_name |
boolean |
project_role |
string (uri) |
project_role_display_name |
string |
project_role_description |
string |
plan |
string (uri) |
plan_attributes |
object (free-form) |
plan_limits |
object (free-form) |
plan_name |
string |
offering_name |
string |
offering_uuid |
string (uuid) |
category_title |
string |
category_url |
string (uri) |
Manage autoprovisioning rules
Manage autoprovisioning rules.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedRuleRequest - API Source:
autoprovisioning_rules_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
name |
string | |
user_affiliations |
array of strings | |
user_email_patterns |
array of strings | |
customer |
string (uri) | |
use_user_organization_as_customer_name |
boolean | |
project_role |
string (uri) | |
project_role_name |
string | |
plan |
string (uri) | |
plan_attributes |
object (free-form) | |
plan_limits |
object (free-form) |
200 -
| Field | Type |
|---|---|
name |
string |
uuid |
string (uuid) |
url |
string (uri) |
user_affiliations |
array of strings |
user_email_patterns |
array of strings |
customer |
string (uri) |
customer_name |
string |
customer_uuid |
string |
use_user_organization_as_customer_name |
boolean |
project_role |
string (uri) |
project_role_display_name |
string |
project_role_description |
string |
plan |
string (uri) |
plan_attributes |
object (free-form) |
plan_limits |
object (free-form) |
plan_name |
string |
offering_name |
string |
offering_uuid |
string (uuid) |
category_title |
string |
category_url |
string (uri) |
Manage autoprovisioning rules
Manage autoprovisioning rules.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
autoprovisioning_rules_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Marketplace Script Async Dry Run
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/marketplace-script-async-dry-run/ |
List Marketplace Script Async Dry Run |
| GET | /api/marketplace-script-async-dry-run/{uuid}/ |
Retrieve |
List Marketplace Script Async Dry Run
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
marketplace_script_async_dry_run_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
order_attributes |
any |
order_type |
string |
order_offering |
string (uri) |
state |
any |
get_state_display |
string |
output |
string |
created |
string (date-time) |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_script_async_dry_run_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
order_attributes |
any |
order_type |
string |
order_offering |
string (uri) |
state |
any |
get_state_display |
string |
output |
string |
created |
string (date-time) |
Marketplace Script Dry Run
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| POST | /api/marketplace-script-dry-run/{uuid}/async_run/ |
Async run |
| POST | /api/marketplace-script-dry-run/{uuid}/run/ |
Run |
Async run
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
DryRunRequest - API Source:
marketplace_script_dry_run_async_run
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
plan |
string (uri) | |
type |
any | |
attributes |
any | |
order_offering |
string (uri) |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
name |
string | |
slug |
string | URL-friendly identifier. Only editable by staff users. |
description |
string | |
full_description |
string | |
privacy_policy_link |
string (uri) | |
access_url |
string (uri) | Publicly accessible offering access URL |
endpoints |
array of objects | |
endpoints.uuid |
string (uuid) | |
endpoints.name |
string | |
endpoints.url |
string | URL of the access endpoint |
software_catalogs |
array of objects | |
software_catalogs.uuid |
string (uuid) | |
software_catalogs.catalog |
any | |
software_catalogs.enabled_cpu_family |
any | List of enabled CPU families: ['x86_64', 'aarch64'] |
software_catalogs.enabled_cpu_microarchitectures |
any | List of enabled CPU microarchitectures: ['generic', 'zen3'] |
software_catalogs.package_count |
integer | |
software_catalogs.partition |
any | |
partitions |
array of objects | |
partitions.uuid |
string (uuid) | |
partitions.partition_name |
string | Name of the SLURM partition |
partitions.cpu_bind |
integer | Default task binding policy (SLURM cpu_bind) |
partitions.def_cpu_per_gpu |
integer | Default CPUs allocated per GPU |
partitions.max_cpus_per_node |
integer | Maximum allocated CPUs per node |
partitions.max_cpus_per_socket |
integer | Maximum allocated CPUs per socket |
partitions.def_mem_per_cpu |
integer (int64) | Default memory per CPU in MB |
partitions.def_mem_per_gpu |
integer (int64) | Default memory per GPU in MB |
partitions.def_mem_per_node |
integer (int64) | Default memory per node in MB |
partitions.max_mem_per_cpu |
integer (int64) | Maximum memory per CPU in MB |
partitions.max_mem_per_node |
integer (int64) | Maximum memory per node in MB |
partitions.default_time |
integer | Default time limit in minutes |
partitions.max_time |
integer | Maximum time limit in minutes |
partitions.grace_time |
integer | Preemption grace time in seconds |
partitions.max_nodes |
integer | Maximum nodes per job |
partitions.min_nodes |
integer | Minimum nodes per job |
partitions.exclusive_topo |
boolean | Exclusive topology access required |
partitions.exclusive_user |
boolean | Exclusive user access required |
partitions.priority_tier |
integer | Priority tier for scheduling and preemption |
partitions.qos |
string | Quality of Service (QOS) name |
partitions.req_resv |
boolean | Require reservation for job allocation |
roles |
array of objects | |
roles.uuid |
string (uuid) | |
roles.name |
string | |
roles.url |
string (uri) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
project |
string (uri) | |
project_uuid |
string (uuid) | |
project_name |
string | |
category |
string (uri) | |
category_uuid |
string (uuid) | |
category_title |
string | |
attributes |
object (free-form) | |
options |
any | |
resource_options |
any | |
components |
array of objects | |
components.uuid |
string (uuid) | |
components.billing_type |
string | Enum: fixed, usage, limit, one, few |
components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
components.name |
string | Display name for the measured unit, for example, Floating IP. |
components.description |
string | |
components.measured_unit |
string | Unit of measurement, for example, GB. |
components.unit_factor |
integer | The conversion factor from backend units to measured_unit |
components.limit_period |
any | |
components.limit_amount |
integer | |
components.article_code |
string | |
components.max_value |
integer | |
components.min_value |
integer | |
components.max_available_limit |
integer | |
components.is_boolean |
boolean | |
components.default_limit |
integer | |
components.factor |
integer | |
components.is_builtin |
boolean | |
components.is_prepaid |
boolean | |
components.overage_component |
string (uuid) | |
components.min_prepaid_duration |
integer | |
components.max_prepaid_duration |
integer | |
plugin_options |
any | |
state |
any | |
vendor_details |
string | |
getting_started |
string | |
integration_guide |
string | |
thumbnail |
string (uri) | |
order_count |
integer | |
plans |
array of objects | |
plans.url |
string (uri) | |
plans.uuid |
string (uuid) | |
plans.name |
string | |
plans.description |
string | |
plans.article_code |
string | |
plans.max_amount |
integer | Maximum number of plans that could be active. Plan is disabled when maximum amount is reached. |
plans.archived |
boolean | Forbids creation of new resources. |
plans.is_active |
boolean | |
plans.unit_price |
string (decimal) | |
plans.unit |
string | Enum: month, quarter, half_month, day, hour, quantity |
plans.init_price |
number (double) | |
plans.switch_price |
number (double) | |
plans.backend_id |
string | |
plans.organization_groups |
array of objects | |
plans.organization_groups.uuid |
string (uuid) | |
plans.organization_groups.url |
string (uri) | |
plans.organization_groups.name |
string | |
plans.organization_groups.parent_uuid |
string (uuid) | UUID of the parent organization group |
plans.organization_groups.parent_name |
string | Name of the parent organization group |
plans.organization_groups.parent |
string (uri) | |
plans.organization_groups.customers_count |
integer | Number of customers in this organization group |
plans.components |
array of objects | |
plans.components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
plans.components.name |
string | Display name for the measured unit, for example, Floating IP. |
plans.components.measured_unit |
string | Unit of measurement, for example, GB. |
plans.components.amount |
integer | |
plans.components.price |
string (decimal) | |
plans.components.future_price |
string (decimal) | |
plans.components.discount_threshold |
integer | Minimum amount to be eligible for discount. |
plans.components.discount_rate |
integer | Discount rate in percentage. |
plans.prices |
object (free-form) | |
plans.future_prices |
object (free-form) | |
plans.quotas |
object (free-form) | |
plans.resources_count |
integer | |
plans.plan_type |
string | |
plans.minimal_price |
number (double) | |
screenshots |
array of objects | |
screenshots.name |
string | |
screenshots.uuid |
string (uuid) | |
screenshots.description |
string | |
screenshots.image |
string (uri) | |
screenshots.thumbnail |
string (uri) | |
screenshots.created |
string (date-time) | |
type |
string | |
shared |
boolean | Accessible to all customers. |
billable |
boolean | Purchase and usage is invoiced. |
scope |
string | |
scope_uuid |
string (uuid) | |
scope_name |
string (uuid) | |
scope_state |
any | |
scope_error_message |
string | |
files |
array of objects | |
files.name |
string | |
files.created |
string (date-time) | |
files.file |
string (uri) | |
quotas |
array of objects | |
quotas.name |
string | |
quotas.usage |
integer | |
quotas.limit |
integer | |
paused_reason |
string | |
datacite_doi |
string | |
citation_count |
integer | Number of citations of a DOI |
latitude |
number (double) | |
longitude |
number (double) | |
country |
any | Country code (ISO 3166-1 alpha-2) |
backend_id |
string | |
organization_groups |
array of objects | |
organization_groups.uuid |
string (uuid) | |
organization_groups.url |
string (uri) | |
organization_groups.name |
string | |
organization_groups.parent_uuid |
string (uuid) | UUID of the parent organization group |
organization_groups.parent_name |
string | Name of the parent organization group |
organization_groups.parent |
string (uri) | |
organization_groups.customers_count |
integer | Number of customers in this organization group |
tags |
array of objects | |
tags.uuid |
string (uuid) | |
tags.name |
string | |
image |
string (uri) | |
total_customers |
integer | |
total_cost |
integer | |
total_cost_estimated |
integer | |
parent_description |
string | |
parent_uuid |
string (uuid) | |
parent_name |
string | |
backend_metadata |
any | |
has_compliance_requirements |
boolean | |
billing_type_classification |
string | Classify offering components by billing type. Returns 'limit_only', 'usage_only', or 'mixed'. |
compliance_checklist |
string (uri) | |
user_has_consent |
boolean | |
is_accessible |
boolean | |
google_calendar_is_public |
boolean | |
google_calendar_link |
string | Get the Google Calendar link for an offering. |
promotion_campaigns |
array of objects | |
promotion_campaigns.uuid |
string (uuid) | |
promotion_campaigns.name |
string | |
promotion_campaigns.start_date |
string (date) | Starting from this date, the campaign is active. |
promotion_campaigns.end_date |
string (date) | The last day the campaign is active. |
promotion_campaigns.discount_type |
string | Enum: discount, special_price |
promotion_campaigns.discount |
integer | |
promotion_campaigns.stock |
integer | |
promotion_campaigns.description |
string | |
promotion_campaigns.months |
integer | How many months in a row should the related service (when activated) get special deal (0 for indefinitely until active) |
promotion_campaigns.service_provider |
string (uri) |
Run
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
DryRunRequest - API Source:
marketplace_script_dry_run_run
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
plan |
string (uri) | |
type |
any | |
attributes |
any | |
order_offering |
string (uri) |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
name |
string | |
slug |
string | URL-friendly identifier. Only editable by staff users. |
description |
string | |
full_description |
string | |
privacy_policy_link |
string (uri) | |
access_url |
string (uri) | Publicly accessible offering access URL |
endpoints |
array of objects | |
endpoints.uuid |
string (uuid) | |
endpoints.name |
string | |
endpoints.url |
string | URL of the access endpoint |
software_catalogs |
array of objects | |
software_catalogs.uuid |
string (uuid) | |
software_catalogs.catalog |
any | |
software_catalogs.enabled_cpu_family |
any | List of enabled CPU families: ['x86_64', 'aarch64'] |
software_catalogs.enabled_cpu_microarchitectures |
any | List of enabled CPU microarchitectures: ['generic', 'zen3'] |
software_catalogs.package_count |
integer | |
software_catalogs.partition |
any | |
partitions |
array of objects | |
partitions.uuid |
string (uuid) | |
partitions.partition_name |
string | Name of the SLURM partition |
partitions.cpu_bind |
integer | Default task binding policy (SLURM cpu_bind) |
partitions.def_cpu_per_gpu |
integer | Default CPUs allocated per GPU |
partitions.max_cpus_per_node |
integer | Maximum allocated CPUs per node |
partitions.max_cpus_per_socket |
integer | Maximum allocated CPUs per socket |
partitions.def_mem_per_cpu |
integer (int64) | Default memory per CPU in MB |
partitions.def_mem_per_gpu |
integer (int64) | Default memory per GPU in MB |
partitions.def_mem_per_node |
integer (int64) | Default memory per node in MB |
partitions.max_mem_per_cpu |
integer (int64) | Maximum memory per CPU in MB |
partitions.max_mem_per_node |
integer (int64) | Maximum memory per node in MB |
partitions.default_time |
integer | Default time limit in minutes |
partitions.max_time |
integer | Maximum time limit in minutes |
partitions.grace_time |
integer | Preemption grace time in seconds |
partitions.max_nodes |
integer | Maximum nodes per job |
partitions.min_nodes |
integer | Minimum nodes per job |
partitions.exclusive_topo |
boolean | Exclusive topology access required |
partitions.exclusive_user |
boolean | Exclusive user access required |
partitions.priority_tier |
integer | Priority tier for scheduling and preemption |
partitions.qos |
string | Quality of Service (QOS) name |
partitions.req_resv |
boolean | Require reservation for job allocation |
roles |
array of objects | |
roles.uuid |
string (uuid) | |
roles.name |
string | |
roles.url |
string (uri) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
project |
string (uri) | |
project_uuid |
string (uuid) | |
project_name |
string | |
category |
string (uri) | |
category_uuid |
string (uuid) | |
category_title |
string | |
attributes |
object (free-form) | |
options |
any | |
resource_options |
any | |
components |
array of objects | |
components.uuid |
string (uuid) | |
components.billing_type |
string | Enum: fixed, usage, limit, one, few |
components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
components.name |
string | Display name for the measured unit, for example, Floating IP. |
components.description |
string | |
components.measured_unit |
string | Unit of measurement, for example, GB. |
components.unit_factor |
integer | The conversion factor from backend units to measured_unit |
components.limit_period |
any | |
components.limit_amount |
integer | |
components.article_code |
string | |
components.max_value |
integer | |
components.min_value |
integer | |
components.max_available_limit |
integer | |
components.is_boolean |
boolean | |
components.default_limit |
integer | |
components.factor |
integer | |
components.is_builtin |
boolean | |
components.is_prepaid |
boolean | |
components.overage_component |
string (uuid) | |
components.min_prepaid_duration |
integer | |
components.max_prepaid_duration |
integer | |
plugin_options |
any | |
state |
any | |
vendor_details |
string | |
getting_started |
string | |
integration_guide |
string | |
thumbnail |
string (uri) | |
order_count |
integer | |
plans |
array of objects | |
plans.url |
string (uri) | |
plans.uuid |
string (uuid) | |
plans.name |
string | |
plans.description |
string | |
plans.article_code |
string | |
plans.max_amount |
integer | Maximum number of plans that could be active. Plan is disabled when maximum amount is reached. |
plans.archived |
boolean | Forbids creation of new resources. |
plans.is_active |
boolean | |
plans.unit_price |
string (decimal) | |
plans.unit |
string | Enum: month, quarter, half_month, day, hour, quantity |
plans.init_price |
number (double) | |
plans.switch_price |
number (double) | |
plans.backend_id |
string | |
plans.organization_groups |
array of objects | |
plans.organization_groups.uuid |
string (uuid) | |
plans.organization_groups.url |
string (uri) | |
plans.organization_groups.name |
string | |
plans.organization_groups.parent_uuid |
string (uuid) | UUID of the parent organization group |
plans.organization_groups.parent_name |
string | Name of the parent organization group |
plans.organization_groups.parent |
string (uri) | |
plans.organization_groups.customers_count |
integer | Number of customers in this organization group |
plans.components |
array of objects | |
plans.components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
plans.components.name |
string | Display name for the measured unit, for example, Floating IP. |
plans.components.measured_unit |
string | Unit of measurement, for example, GB. |
plans.components.amount |
integer | |
plans.components.price |
string (decimal) | |
plans.components.future_price |
string (decimal) | |
plans.components.discount_threshold |
integer | Minimum amount to be eligible for discount. |
plans.components.discount_rate |
integer | Discount rate in percentage. |
plans.prices |
object (free-form) | |
plans.future_prices |
object (free-form) | |
plans.quotas |
object (free-form) | |
plans.resources_count |
integer | |
plans.plan_type |
string | |
plans.minimal_price |
number (double) | |
screenshots |
array of objects | |
screenshots.name |
string | |
screenshots.uuid |
string (uuid) | |
screenshots.description |
string | |
screenshots.image |
string (uri) | |
screenshots.thumbnail |
string (uri) | |
screenshots.created |
string (date-time) | |
type |
string | |
shared |
boolean | Accessible to all customers. |
billable |
boolean | Purchase and usage is invoiced. |
scope |
string | |
scope_uuid |
string (uuid) | |
scope_name |
string (uuid) | |
scope_state |
any | |
scope_error_message |
string | |
files |
array of objects | |
files.name |
string | |
files.created |
string (date-time) | |
files.file |
string (uri) | |
quotas |
array of objects | |
quotas.name |
string | |
quotas.usage |
integer | |
quotas.limit |
integer | |
paused_reason |
string | |
datacite_doi |
string | |
citation_count |
integer | Number of citations of a DOI |
latitude |
number (double) | |
longitude |
number (double) | |
country |
any | Country code (ISO 3166-1 alpha-2) |
backend_id |
string | |
organization_groups |
array of objects | |
organization_groups.uuid |
string (uuid) | |
organization_groups.url |
string (uri) | |
organization_groups.name |
string | |
organization_groups.parent_uuid |
string (uuid) | UUID of the parent organization group |
organization_groups.parent_name |
string | Name of the parent organization group |
organization_groups.parent |
string (uri) | |
organization_groups.customers_count |
integer | Number of customers in this organization group |
tags |
array of objects | |
tags.uuid |
string (uuid) | |
tags.name |
string | |
image |
string (uri) | |
total_customers |
integer | |
total_cost |
integer | |
total_cost_estimated |
integer | |
parent_description |
string | |
parent_uuid |
string (uuid) | |
parent_name |
string | |
backend_metadata |
any | |
has_compliance_requirements |
boolean | |
billing_type_classification |
string | Classify offering components by billing type. Returns 'limit_only', 'usage_only', or 'mixed'. |
compliance_checklist |
string (uri) | |
user_has_consent |
boolean | |
is_accessible |
boolean | |
google_calendar_is_public |
boolean | |
google_calendar_link |
string | Get the Google Calendar link for an offering. |
promotion_campaigns |
array of objects | |
promotion_campaigns.uuid |
string (uuid) | |
promotion_campaigns.name |
string | |
promotion_campaigns.start_date |
string (date) | Starting from this date, the campaign is active. |
promotion_campaigns.end_date |
string (date) | The last day the campaign is active. |
promotion_campaigns.discount_type |
string | Enum: discount, special_price |
promotion_campaigns.discount |
integer | |
promotion_campaigns.stock |
integer | |
promotion_campaigns.description |
string | |
promotion_campaigns.months |
integer | How many months in a row should the related service (when activated) get special deal (0 for indefinitely until active) |
promotion_campaigns.service_provider |
string (uri) |
Marketplace Script Sync Resource
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| POST | /api/marketplace-script-sync-resource/ |
Pull a marketplace script resource |
Pull a marketplace script resource
Pull a marketplace script resource.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
- Model Source:
PullMarketplaceScriptResourceRequest - API Source:
marketplace_script_sync_resource
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Field | Type | Required |
|---|---|---|
resource_uuid |
string (uuid) | ✓ |
202 - No response body
404 - No response body
User Action Executions
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/user-action-executions/ |
List User Action Executions |
| GET | /api/user-action-executions/{id}/ |
Retrieve |
List User Action Executions
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
user_action_executions_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
o |
string | Which field to use when ordering the results. |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
id |
integer |
corrective_action_label |
string |
executed_at |
string (date-time) |
success |
boolean |
error_message |
string |
execution_metadata |
string |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
user_action_executions_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required | Description |
|---|---|---|---|
id |
integer | ✓ | A unique integer value identifying this user action execution. |
200 -
| Field | Type |
|---|---|
id |
integer |
corrective_action_label |
string |
executed_at |
string (date-time) |
success |
boolean |
error_message |
string |
execution_metadata |
string |
User Action Providers
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/user-action-providers/ |
List User Action Providers |
| GET | /api/user-action-providers/{id}/ |
Retrieve |
List User Action Providers
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
user_action_providers_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
id |
integer |
app_name |
string |
provider_class |
string |
action_type |
string |
is_enabled |
boolean |
schedule |
string |
last_execution |
string (date-time) |
last_execution_status |
string |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
user_action_providers_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required | Description |
|---|---|---|---|
id |
integer | ✓ | A unique integer value identifying this user action provider. |
200 -
| Field | Type |
|---|---|
id |
integer |
app_name |
string |
provider_class |
string |
action_type |
string |
is_enabled |
boolean |
schedule |
string |
last_execution |
string (date-time) |
last_execution_status |
string |
User Actions
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/user-actions/ |
List User Actions |
| GET | /api/user-actions/{uuid}/ |
Retrieve |
| POST | /api/user-actions/update_actions/ |
Trigger update of user actions |
| Other Actions | ||
| GET | /api/user-actions/summary/ |
Get action summary counts |
| POST | /api/user-actions/bulk_silence/ |
Bulk silence actions by filters |
| POST | /api/user-actions/{uuid}/execute_action/ |
Execute a corrective action |
| POST | /api/user-actions/{uuid}/silence/ |
Silence an action temporarily or permanently |
| POST | /api/user-actions/{uuid}/unsilence/ |
Remove silence from an action |
Core CRUD
List User Actions
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 | |
- Model Source:
UrgencyEnum - API Source:
user_actions_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
action_type |
string | |
created_after |
string (date-time) | |
created_before |
string (date-time) | |
due_within_days |
number | |
include_silenced |
boolean | |
is_silenced |
boolean | |
o |
string | Which field to use when ordering the results. |
overdue |
boolean | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
urgency |
string | Enum: low, medium, high |
user_uuid |
string (uuid) | Filter by user UUID (staff only). |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
action_type |
string | Type of action, e.g. 'pending_order', 'expiring_resource' |
title |
string | |
description |
string | |
urgency |
string | Enum: low, medium, high |
due_date |
string (date-time) | |
is_silenced |
boolean | |
silenced_until |
string (date-time) | |
is_temporarily_silenced |
boolean | |
is_effectively_silenced |
boolean | |
created |
string (date-time) | |
modified |
string (date-time) | |
related_object_name |
string | |
related_object_type |
string | |
corrective_actions |
array of objects | |
corrective_actions.label |
string | |
corrective_actions.category |
string | Enum: view, approve, reject, extend, terminate, backup, migrate, contact, escalate, configure, repair, monitor |
corrective_actions.severity |
string | Enum: safe, low, medium, high, critical |
corrective_actions.method |
string | |
corrective_actions.api_endpoint |
boolean | |
corrective_actions.confirmation_required |
boolean | |
corrective_actions.permissions_required |
array of strings | |
corrective_actions.metadata |
object (free-form) | |
corrective_actions.route_name |
string | |
corrective_actions.route_params |
object (free-form) | |
days_until_due |
integer | |
route_name |
string | UI-Router state name for navigation |
route_params |
object (free-form) | |
project_name |
string | |
project_uuid |
string (uuid) | |
organization_name |
string | |
organization_uuid |
string (uuid) | |
offering_name |
string | |
offering_uuid |
string (uuid) | |
offering_type |
string | |
resource_name |
string | |
resource_uuid |
string (uuid) | |
order_type |
string |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
user_actions_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
action_type |
string | Type of action, e.g. 'pending_order', 'expiring_resource' |
title |
string | |
description |
string | |
urgency |
string | Enum: low, medium, high |
due_date |
string (date-time) | |
is_silenced |
boolean | |
silenced_until |
string (date-time) | |
is_temporarily_silenced |
boolean | |
is_effectively_silenced |
boolean | |
created |
string (date-time) | |
modified |
string (date-time) | |
related_object_name |
string | |
related_object_type |
string | |
corrective_actions |
array of objects | |
corrective_actions.label |
string | |
corrective_actions.category |
string | Enum: view, approve, reject, extend, terminate, backup, migrate, contact, escalate, configure, repair, monitor |
corrective_actions.severity |
string | Enum: safe, low, medium, high, critical |
corrective_actions.method |
string | |
corrective_actions.api_endpoint |
boolean | |
corrective_actions.confirmation_required |
boolean | |
corrective_actions.permissions_required |
array of strings | |
corrective_actions.metadata |
object (free-form) | |
corrective_actions.route_name |
string | |
corrective_actions.route_params |
object (free-form) | |
days_until_due |
integer | |
route_name |
string | UI-Router state name for navigation |
route_params |
object (free-form) | |
project_name |
string | |
project_uuid |
string (uuid) | |
organization_name |
string | |
organization_uuid |
string (uuid) | |
offering_name |
string | |
offering_uuid |
string (uuid) | |
offering_type |
string | |
resource_name |
string | |
resource_uuid |
string (uuid) | |
order_type |
string |
Trigger update of user actions
Trigger update of user actions
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
- Model Source:
UpdateActionsRequest - API Source:
user_actions_update_actions
1 2 3 4 5 6 7 8 9 10 | |
| Field | Type | Required | Description |
|---|---|---|---|
provider_action_type |
string | Optional provider action type to update. If not provided, updates all providers. |
202 -
| Field | Type |
|---|---|
status |
string |
message |
string |
provider_action_type |
string |
Other Actions
Get action summary counts
Get action summary counts
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
- API Source:
user_actions_summary_retrieve
1 2 3 4 5 6 7 8 9 10 | |
200 -
| Field | Type |
|---|---|
total |
integer |
by_urgency |
object (free-form) |
by_type |
object (free-form) |
overdue |
integer |
Bulk silence actions by filters
Bulk silence actions by filters
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
- Model Source:
SilenceActionRequest - API Source:
user_actions_bulk_silence
1 2 3 4 5 6 7 8 9 10 | |
| Field | Type | Required | Description |
|---|---|---|---|
duration_days |
integer | Duration in days to silence the action. If not provided, silences permanently. |
200 -
| Field | Type |
|---|---|
status |
string |
count |
integer |
duration_days |
integer |
Execute a corrective action
Execute a corrective action
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
ExecuteActionRequest - API Source:
user_actions_execute_action
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
action_label |
string | ✓ | Label of the corrective action to execute |
200 -
| Field | Type |
|---|---|
action |
string |
message |
string |
redirect_url |
string (uri) |
metadata |
object (free-form) |
404 -
| Field | Type |
|---|---|
error |
string |
500 -
| Field | Type |
|---|---|
error |
string |
Silence an action temporarily or permanently
Silence an action temporarily or permanently
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
SilenceActionRequest - API Source:
user_actions_silence
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
duration_days |
integer | Duration in days to silence the action. If not provided, silences permanently. |
200 -
| Field | Type |
|---|---|
status |
string |
duration_days |
integer |
Remove silence from an action
Remove silence from an action
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
user_actions_unsilence
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
status |
string |
Booking
Marketplace Bookings
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/marketplace-bookings/{uuid}/ |
Retrieve |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- API Source:
marketplace_bookings_list
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string | ✓ |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
created_by_full_name |
string |
start |
string (date-time) |
end |
string (date-time) |
Booking Offerings
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/booking-offerings/ |
List Booking Offerings |
| GET | /api/booking-offerings/{uuid}/ |
Retrieve |
| Other Actions | ||
| POST | /api/booking-offerings/{uuid}/google_calendar_sync/ |
Google calendar sync |
| POST | /api/booking-offerings/{uuid}/share_google_calendar/ |
Share google calendar |
| POST | /api/booking-offerings/{uuid}/unshare_google_calendar/ |
Unshare google calendar |
Core CRUD
List Booking Offerings
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 | |
- Model Source:
OfferingFieldEnum - API Source:
booking_offerings_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
field |
array | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
name |
string | |
slug |
string | URL-friendly identifier. Only editable by staff users. |
description |
string | |
full_description |
string | |
privacy_policy_link |
string (uri) | |
access_url |
string (uri) | Publicly accessible offering access URL |
endpoints |
array of objects | |
endpoints.uuid |
string (uuid) | |
endpoints.name |
string | |
endpoints.url |
string | URL of the access endpoint |
software_catalogs |
array of objects | |
software_catalogs.uuid |
string (uuid) | |
software_catalogs.catalog |
any | |
software_catalogs.enabled_cpu_family |
any | List of enabled CPU families: ['x86_64', 'aarch64'] |
software_catalogs.enabled_cpu_microarchitectures |
any | List of enabled CPU microarchitectures: ['generic', 'zen3'] |
software_catalogs.package_count |
integer | |
software_catalogs.partition |
any | |
partitions |
array of objects | |
partitions.uuid |
string (uuid) | |
partitions.partition_name |
string | Name of the SLURM partition |
partitions.cpu_bind |
integer | Default task binding policy (SLURM cpu_bind) |
partitions.def_cpu_per_gpu |
integer | Default CPUs allocated per GPU |
partitions.max_cpus_per_node |
integer | Maximum allocated CPUs per node |
partitions.max_cpus_per_socket |
integer | Maximum allocated CPUs per socket |
partitions.def_mem_per_cpu |
integer (int64) | Default memory per CPU in MB |
partitions.def_mem_per_gpu |
integer (int64) | Default memory per GPU in MB |
partitions.def_mem_per_node |
integer (int64) | Default memory per node in MB |
partitions.max_mem_per_cpu |
integer (int64) | Maximum memory per CPU in MB |
partitions.max_mem_per_node |
integer (int64) | Maximum memory per node in MB |
partitions.default_time |
integer | Default time limit in minutes |
partitions.max_time |
integer | Maximum time limit in minutes |
partitions.grace_time |
integer | Preemption grace time in seconds |
partitions.max_nodes |
integer | Maximum nodes per job |
partitions.min_nodes |
integer | Minimum nodes per job |
partitions.exclusive_topo |
boolean | Exclusive topology access required |
partitions.exclusive_user |
boolean | Exclusive user access required |
partitions.priority_tier |
integer | Priority tier for scheduling and preemption |
partitions.qos |
string | Quality of Service (QOS) name |
partitions.req_resv |
boolean | Require reservation for job allocation |
roles |
array of objects | |
roles.uuid |
string (uuid) | |
roles.name |
string | |
roles.url |
string (uri) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
project |
string (uri) | |
project_uuid |
string (uuid) | |
project_name |
string | |
category |
string (uri) | |
category_uuid |
string (uuid) | |
category_title |
string | |
attributes |
object (free-form) | |
options |
any | |
resource_options |
any | |
components |
array of objects | |
components.uuid |
string (uuid) | |
components.billing_type |
string | Enum: fixed, usage, limit, one, few |
components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
components.name |
string | Display name for the measured unit, for example, Floating IP. |
components.description |
string | |
components.measured_unit |
string | Unit of measurement, for example, GB. |
components.unit_factor |
integer | The conversion factor from backend units to measured_unit |
components.limit_period |
any | |
components.limit_amount |
integer | |
components.article_code |
string | |
components.max_value |
integer | |
components.min_value |
integer | |
components.max_available_limit |
integer | |
components.is_boolean |
boolean | |
components.default_limit |
integer | |
components.factor |
integer | |
components.is_builtin |
boolean | |
components.is_prepaid |
boolean | |
components.overage_component |
string (uuid) | |
components.min_prepaid_duration |
integer | |
components.max_prepaid_duration |
integer | |
plugin_options |
any | |
state |
any | |
vendor_details |
string | |
getting_started |
string | |
integration_guide |
string | |
thumbnail |
string (uri) | |
order_count |
integer | |
plans |
array of objects | |
plans.url |
string (uri) | |
plans.uuid |
string (uuid) | |
plans.name |
string | |
plans.description |
string | |
plans.article_code |
string | |
plans.max_amount |
integer | Maximum number of plans that could be active. Plan is disabled when maximum amount is reached. |
plans.archived |
boolean | Forbids creation of new resources. |
plans.is_active |
boolean | |
plans.unit_price |
string (decimal) | |
plans.unit |
string | Enum: month, quarter, half_month, day, hour, quantity |
plans.init_price |
number (double) | |
plans.switch_price |
number (double) | |
plans.backend_id |
string | |
plans.organization_groups |
array of objects | |
plans.organization_groups.uuid |
string (uuid) | |
plans.organization_groups.url |
string (uri) | |
plans.organization_groups.name |
string | |
plans.organization_groups.parent_uuid |
string (uuid) | UUID of the parent organization group |
plans.organization_groups.parent_name |
string | Name of the parent organization group |
plans.organization_groups.parent |
string (uri) | |
plans.organization_groups.customers_count |
integer | Number of customers in this organization group |
plans.components |
array of objects | |
plans.components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
plans.components.name |
string | Display name for the measured unit, for example, Floating IP. |
plans.components.measured_unit |
string | Unit of measurement, for example, GB. |
plans.components.amount |
integer | |
plans.components.price |
string (decimal) | |
plans.components.future_price |
string (decimal) | |
plans.components.discount_threshold |
integer | Minimum amount to be eligible for discount. |
plans.components.discount_rate |
integer | Discount rate in percentage. |
plans.prices |
object (free-form) | |
plans.future_prices |
object (free-form) | |
plans.quotas |
object (free-form) | |
plans.resources_count |
integer | |
plans.plan_type |
string | |
plans.minimal_price |
number (double) | |
screenshots |
array of objects | |
screenshots.name |
string | |
screenshots.uuid |
string (uuid) | |
screenshots.description |
string | |
screenshots.image |
string (uri) | |
screenshots.thumbnail |
string (uri) | |
screenshots.created |
string (date-time) | |
type |
string | |
shared |
boolean | Accessible to all customers. |
billable |
boolean | Purchase and usage is invoiced. |
scope |
string | |
scope_uuid |
string (uuid) | |
scope_name |
string (uuid) | |
scope_state |
any | |
scope_error_message |
string | |
files |
array of objects | |
files.name |
string | |
files.created |
string (date-time) | |
files.file |
string (uri) | |
quotas |
array of objects | |
quotas.name |
string | |
quotas.usage |
integer | |
quotas.limit |
integer | |
paused_reason |
string | |
datacite_doi |
string | |
citation_count |
integer | Number of citations of a DOI |
latitude |
number (double) | |
longitude |
number (double) | |
country |
any | Country code (ISO 3166-1 alpha-2) |
backend_id |
string | |
organization_groups |
array of objects | |
organization_groups.uuid |
string (uuid) | |
organization_groups.url |
string (uri) | |
organization_groups.name |
string | |
organization_groups.parent_uuid |
string (uuid) | UUID of the parent organization group |
organization_groups.parent_name |
string | Name of the parent organization group |
organization_groups.parent |
string (uri) | |
organization_groups.customers_count |
integer | Number of customers in this organization group |
tags |
array of objects | |
tags.uuid |
string (uuid) | |
tags.name |
string | |
image |
string (uri) | |
total_customers |
integer | |
total_cost |
integer | |
total_cost_estimated |
integer | |
parent_description |
string | |
parent_uuid |
string (uuid) | |
parent_name |
string | |
backend_metadata |
any | |
has_compliance_requirements |
boolean | |
billing_type_classification |
string | Classify offering components by billing type. Returns 'limit_only', 'usage_only', or 'mixed'. |
compliance_checklist |
string (uri) | |
user_has_consent |
boolean | |
is_accessible |
boolean | |
googlecalendar |
object | |
googlecalendar.backend_id |
string | |
googlecalendar.public |
boolean | |
googlecalendar.http_link |
string |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
OfferingFieldEnum - API Source:
booking_offerings_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
name |
string | |
slug |
string | URL-friendly identifier. Only editable by staff users. |
description |
string | |
full_description |
string | |
privacy_policy_link |
string (uri) | |
access_url |
string (uri) | Publicly accessible offering access URL |
endpoints |
array of objects | |
endpoints.uuid |
string (uuid) | |
endpoints.name |
string | |
endpoints.url |
string | URL of the access endpoint |
software_catalogs |
array of objects | |
software_catalogs.uuid |
string (uuid) | |
software_catalogs.catalog |
any | |
software_catalogs.enabled_cpu_family |
any | List of enabled CPU families: ['x86_64', 'aarch64'] |
software_catalogs.enabled_cpu_microarchitectures |
any | List of enabled CPU microarchitectures: ['generic', 'zen3'] |
software_catalogs.package_count |
integer | |
software_catalogs.partition |
any | |
partitions |
array of objects | |
partitions.uuid |
string (uuid) | |
partitions.partition_name |
string | Name of the SLURM partition |
partitions.cpu_bind |
integer | Default task binding policy (SLURM cpu_bind) |
partitions.def_cpu_per_gpu |
integer | Default CPUs allocated per GPU |
partitions.max_cpus_per_node |
integer | Maximum allocated CPUs per node |
partitions.max_cpus_per_socket |
integer | Maximum allocated CPUs per socket |
partitions.def_mem_per_cpu |
integer (int64) | Default memory per CPU in MB |
partitions.def_mem_per_gpu |
integer (int64) | Default memory per GPU in MB |
partitions.def_mem_per_node |
integer (int64) | Default memory per node in MB |
partitions.max_mem_per_cpu |
integer (int64) | Maximum memory per CPU in MB |
partitions.max_mem_per_node |
integer (int64) | Maximum memory per node in MB |
partitions.default_time |
integer | Default time limit in minutes |
partitions.max_time |
integer | Maximum time limit in minutes |
partitions.grace_time |
integer | Preemption grace time in seconds |
partitions.max_nodes |
integer | Maximum nodes per job |
partitions.min_nodes |
integer | Minimum nodes per job |
partitions.exclusive_topo |
boolean | Exclusive topology access required |
partitions.exclusive_user |
boolean | Exclusive user access required |
partitions.priority_tier |
integer | Priority tier for scheduling and preemption |
partitions.qos |
string | Quality of Service (QOS) name |
partitions.req_resv |
boolean | Require reservation for job allocation |
roles |
array of objects | |
roles.uuid |
string (uuid) | |
roles.name |
string | |
roles.url |
string (uri) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
project |
string (uri) | |
project_uuid |
string (uuid) | |
project_name |
string | |
category |
string (uri) | |
category_uuid |
string (uuid) | |
category_title |
string | |
attributes |
object (free-form) | |
options |
any | |
resource_options |
any | |
components |
array of objects | |
components.uuid |
string (uuid) | |
components.billing_type |
string | Enum: fixed, usage, limit, one, few |
components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
components.name |
string | Display name for the measured unit, for example, Floating IP. |
components.description |
string | |
components.measured_unit |
string | Unit of measurement, for example, GB. |
components.unit_factor |
integer | The conversion factor from backend units to measured_unit |
components.limit_period |
any | |
components.limit_amount |
integer | |
components.article_code |
string | |
components.max_value |
integer | |
components.min_value |
integer | |
components.max_available_limit |
integer | |
components.is_boolean |
boolean | |
components.default_limit |
integer | |
components.factor |
integer | |
components.is_builtin |
boolean | |
components.is_prepaid |
boolean | |
components.overage_component |
string (uuid) | |
components.min_prepaid_duration |
integer | |
components.max_prepaid_duration |
integer | |
plugin_options |
any | |
state |
any | |
vendor_details |
string | |
getting_started |
string | |
integration_guide |
string | |
thumbnail |
string (uri) | |
order_count |
integer | |
plans |
array of objects | |
plans.url |
string (uri) | |
plans.uuid |
string (uuid) | |
plans.name |
string | |
plans.description |
string | |
plans.article_code |
string | |
plans.max_amount |
integer | Maximum number of plans that could be active. Plan is disabled when maximum amount is reached. |
plans.archived |
boolean | Forbids creation of new resources. |
plans.is_active |
boolean | |
plans.unit_price |
string (decimal) | |
plans.unit |
string | Enum: month, quarter, half_month, day, hour, quantity |
plans.init_price |
number (double) | |
plans.switch_price |
number (double) | |
plans.backend_id |
string | |
plans.organization_groups |
array of objects | |
plans.organization_groups.uuid |
string (uuid) | |
plans.organization_groups.url |
string (uri) | |
plans.organization_groups.name |
string | |
plans.organization_groups.parent_uuid |
string (uuid) | UUID of the parent organization group |
plans.organization_groups.parent_name |
string | Name of the parent organization group |
plans.organization_groups.parent |
string (uri) | |
plans.organization_groups.customers_count |
integer | Number of customers in this organization group |
plans.components |
array of objects | |
plans.components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
plans.components.name |
string | Display name for the measured unit, for example, Floating IP. |
plans.components.measured_unit |
string | Unit of measurement, for example, GB. |
plans.components.amount |
integer | |
plans.components.price |
string (decimal) | |
plans.components.future_price |
string (decimal) | |
plans.components.discount_threshold |
integer | Minimum amount to be eligible for discount. |
plans.components.discount_rate |
integer | Discount rate in percentage. |
plans.prices |
object (free-form) | |
plans.future_prices |
object (free-form) | |
plans.quotas |
object (free-form) | |
plans.resources_count |
integer | |
plans.plan_type |
string | |
plans.minimal_price |
number (double) | |
screenshots |
array of objects | |
screenshots.name |
string | |
screenshots.uuid |
string (uuid) | |
screenshots.description |
string | |
screenshots.image |
string (uri) | |
screenshots.thumbnail |
string (uri) | |
screenshots.created |
string (date-time) | |
type |
string | |
shared |
boolean | Accessible to all customers. |
billable |
boolean | Purchase and usage is invoiced. |
scope |
string | |
scope_uuid |
string (uuid) | |
scope_name |
string (uuid) | |
scope_state |
any | |
scope_error_message |
string | |
files |
array of objects | |
files.name |
string | |
files.created |
string (date-time) | |
files.file |
string (uri) | |
quotas |
array of objects | |
quotas.name |
string | |
quotas.usage |
integer | |
quotas.limit |
integer | |
paused_reason |
string | |
datacite_doi |
string | |
citation_count |
integer | Number of citations of a DOI |
latitude |
number (double) | |
longitude |
number (double) | |
country |
any | Country code (ISO 3166-1 alpha-2) |
backend_id |
string | |
organization_groups |
array of objects | |
organization_groups.uuid |
string (uuid) | |
organization_groups.url |
string (uri) | |
organization_groups.name |
string | |
organization_groups.parent_uuid |
string (uuid) | UUID of the parent organization group |
organization_groups.parent_name |
string | Name of the parent organization group |
organization_groups.parent |
string (uri) | |
organization_groups.customers_count |
integer | Number of customers in this organization group |
tags |
array of objects | |
tags.uuid |
string (uuid) | |
tags.name |
string | |
image |
string (uri) | |
total_customers |
integer | |
total_cost |
integer | |
total_cost_estimated |
integer | |
parent_description |
string | |
parent_uuid |
string (uuid) | |
parent_name |
string | |
backend_metadata |
any | |
has_compliance_requirements |
boolean | |
billing_type_classification |
string | Classify offering components by billing type. Returns 'limit_only', 'usage_only', or 'mixed'. |
compliance_checklist |
string (uri) | |
user_has_consent |
boolean | |
is_accessible |
boolean | |
googlecalendar |
object | |
googlecalendar.backend_id |
string | |
googlecalendar.public |
boolean | |
googlecalendar.http_link |
string |
Other Actions
Google calendar sync
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
booking_offerings_google_calendar_sync
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - No response body
Share google calendar
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
booking_offerings_share_google_calendar
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - No response body
Unshare google calendar
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
booking_offerings_unshare_google_calendar
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - No response body
Booking Resources
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/booking-resources/ |
List Booking Resources |
| GET | /api/booking-resources/{uuid}/ |
Retrieve |
| Other Actions | ||
| POST | /api/booking-resources/{uuid}/accept/ |
Accept |
| POST | /api/booking-resources/{uuid}/reject/ |
Reject |
Core CRUD
List Booking Resources
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
- Model Source:
BookingResourceFieldEnum - Model Source:
BookingResourceOEnum - Model Source:
OrderState - Model Source:
ResourceState - API Source:
booking_resources_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
backend_id |
string | Backend ID |
category_uuid |
string (uuid) | Category UUID |
component_count |
number | Filter by exact number of components |
connected_customer_uuid |
string (uuid) | |
created |
string (date-time) | Created after |
customer |
string (uri) | Customer URL |
customer_uuid |
string (uuid) | Customer UUID |
downscaled |
boolean | Downscaled |
field |
array | |
has_terminate_date |
boolean | Has termination date |
is_attached |
boolean | Filter by attached state |
lexis_links_supported |
boolean | LEXIS links supported |
limit_based |
boolean | Filter by limit-based offerings |
limit_component_count |
number | Filter by exact number of limit-based components |
modified |
string (date-time) | Modified after |
name |
string | Name |
name_exact |
string | Name (exact) |
o |
array | Ordering |
offering |
string (uri) | |
offering_billable |
boolean | Offering billable |
offering_shared |
boolean | Offering shared |
offering_slug |
array | Multiple values may be separated by commas. |
offering_type |
string | Offering type |
offering_uuid |
array | Multiple values may be separated by commas. |
only_limit_based |
boolean | Filter resources with only limit-based components |
only_usage_based |
boolean | Filter resources with only usage-based components |
order_state |
array | Order state |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
parent_offering_uuid |
string (uuid) | |
paused |
boolean | Paused |
plan_uuid |
string (uuid) | Plan UUID |
project_name |
string | Project name |
project_uuid |
string (uuid) | Project UUID |
provider_uuid |
string (uuid) | Provider UUID |
query |
string | Search by resource UUID, name, slug, backend ID, effective ID, IPs or hypervisor |
restrict_member_access |
boolean | Restrict member access |
runtime_state |
string | Runtime state |
service_manager_uuid |
string (uuid) | Service manager UUID |
state |
array | Resource state |
usage_based |
boolean | Filter by usage-based offerings |
visible_to_providers |
boolean | Include only resources visible to service providers |
visible_to_username |
string | Visible to username |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
offering |
string (uri) | |
offering_name |
string | |
offering_uuid |
string (uuid) | |
offering_description |
string | |
offering_image |
string (uri) | |
offering_thumbnail |
string (uri) | |
offering_type |
string | |
offering_shared |
boolean | Accessible to all customers. |
offering_billable |
boolean | Purchase and usage is invoiced. |
offering_plugin_options |
any | Public data used by specific plugin, such as storage mode for OpenStack. |
provider_name |
string | |
provider_uuid |
string (uuid) | |
provider_slug |
string | |
category_title |
string | |
category_uuid |
string (uuid) | |
category_icon |
string (uri) | |
plan |
string (uri) | |
plan_unit |
any | |
plan_name |
string | |
plan_uuid |
string (uuid) | |
plan_description |
string | |
attributes |
object (free-form) | |
limits |
object (free-form) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
modified |
string (date-time) | |
url |
string (uri) | |
scope |
string | |
description |
string | |
state |
any | |
resource_uuid |
string (uuid) | |
backend_id |
string | |
effective_id |
string | |
resource_type |
string | |
project |
string (uri) | |
project_uuid |
string (uuid) | |
project_name |
string | |
project_description |
string | |
project_end_date |
string (date) | The date is inclusive. Once reached, all project resource will be scheduled for termination. |
project_end_date_requested_by |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
offering_slug |
string | |
parent_offering_uuid |
string (uuid) | |
parent_offering_name |
string | |
parent_offering_slug |
string | |
offering_backend_id |
string | |
parent_uuid |
string (uuid) | |
parent_name |
string | |
backend_metadata |
any | |
is_usage_based |
boolean | Returns True if the resource has usage-based components that track variable consumption. |
is_limit_based |
boolean | Returns True if the resource has limit-based components with user-adjustable quotas. |
name |
string | |
slug |
string | URL-friendly identifier. Only editable by staff users. |
current_usages |
object (free-form) | Dictionary mapping component types to their latest reported usage amounts. |
can_terminate |
boolean | |
report |
array of objects | |
report.header |
string | Section header text |
report.body |
string | Section body content |
end_date |
string (date) | The date is inclusive. Once reached, a resource will be scheduled for termination. |
end_date_requested_by |
string (uri) | |
username |
string | |
limit_usage |
object (free-form) | Dictionary mapping limit-based component types to their consumed usage. For monthly periods, maps from current_usages; for longer periods, aggregates historical usage. |
downscaled |
boolean | |
restrict_member_access |
boolean | |
paused |
boolean | |
endpoints |
array of objects | |
endpoints.uuid |
string (uuid) | |
endpoints.name |
string | |
endpoints.url |
string | URL of the access endpoint |
error_message |
string | |
error_traceback |
string | |
options |
any | |
available_actions |
array of strings | |
last_sync |
string (date-time) | |
order_in_progress |
any | |
creation_order |
any | |
service_settings_uuid |
string (uuid) | |
project_slug |
string | |
customer_slug |
string | |
user_requires_reconsent |
boolean | Check if the current user needs to re-consent for this resource's offering. |
renewal_date |
object (free-form) | |
offering_state |
any | |
offering_components |
array of objects | |
offering_components.uuid |
string (uuid) | |
offering_components.billing_type |
string | Enum: fixed, usage, limit, one, few |
offering_components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
offering_components.name |
string | Display name for the measured unit, for example, Floating IP. |
offering_components.description |
string | |
offering_components.measured_unit |
string | Unit of measurement, for example, GB. |
offering_components.unit_factor |
integer | The conversion factor from backend units to measured_unit |
offering_components.limit_period |
any | |
offering_components.limit_amount |
integer | |
offering_components.article_code |
string | |
offering_components.max_value |
integer | |
offering_components.min_value |
integer | |
offering_components.max_available_limit |
integer | |
offering_components.is_boolean |
boolean | |
offering_components.default_limit |
integer | |
offering_components.factor |
integer | |
offering_components.is_builtin |
boolean | |
offering_components.is_prepaid |
boolean | |
offering_components.overage_component |
string (uuid) | |
offering_components.min_prepaid_duration |
integer | |
offering_components.max_prepaid_duration |
integer | |
created_by |
string (uri) | |
created_by_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
created_by_full_name |
string | |
consumer_reviewed_by |
string (uri) | |
consumer_reviewed_by_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
consumer_reviewed_by_full_name |
string | |
slots |
array of objects | |
slots.start |
string (date-time) | |
slots.end |
string (date-time) | |
slots.backend_id |
string |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
BookingResourceFieldEnum - API Source:
booking_resources_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type | Description |
|---|---|---|
offering |
string (uri) | |
offering_name |
string | |
offering_uuid |
string (uuid) | |
offering_description |
string | |
offering_image |
string (uri) | |
offering_thumbnail |
string (uri) | |
offering_type |
string | |
offering_shared |
boolean | Accessible to all customers. |
offering_billable |
boolean | Purchase and usage is invoiced. |
offering_plugin_options |
any | Public data used by specific plugin, such as storage mode for OpenStack. |
provider_name |
string | |
provider_uuid |
string (uuid) | |
provider_slug |
string | |
category_title |
string | |
category_uuid |
string (uuid) | |
category_icon |
string (uri) | |
plan |
string (uri) | |
plan_unit |
any | |
plan_name |
string | |
plan_uuid |
string (uuid) | |
plan_description |
string | |
attributes |
object (free-form) | |
limits |
object (free-form) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
modified |
string (date-time) | |
url |
string (uri) | |
scope |
string | |
description |
string | |
state |
any | |
resource_uuid |
string (uuid) | |
backend_id |
string | |
effective_id |
string | |
resource_type |
string | |
project |
string (uri) | |
project_uuid |
string (uuid) | |
project_name |
string | |
project_description |
string | |
project_end_date |
string (date) | The date is inclusive. Once reached, all project resource will be scheduled for termination. |
project_end_date_requested_by |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
offering_slug |
string | |
parent_offering_uuid |
string (uuid) | |
parent_offering_name |
string | |
parent_offering_slug |
string | |
offering_backend_id |
string | |
parent_uuid |
string (uuid) | |
parent_name |
string | |
backend_metadata |
any | |
is_usage_based |
boolean | Returns True if the resource has usage-based components that track variable consumption. |
is_limit_based |
boolean | Returns True if the resource has limit-based components with user-adjustable quotas. |
name |
string | |
slug |
string | URL-friendly identifier. Only editable by staff users. |
current_usages |
object (free-form) | Dictionary mapping component types to their latest reported usage amounts. |
can_terminate |
boolean | |
report |
array of objects | |
report.header |
string | Section header text |
report.body |
string | Section body content |
end_date |
string (date) | The date is inclusive. Once reached, a resource will be scheduled for termination. |
end_date_requested_by |
string (uri) | |
username |
string | |
limit_usage |
object (free-form) | Dictionary mapping limit-based component types to their consumed usage. For monthly periods, maps from current_usages; for longer periods, aggregates historical usage. |
downscaled |
boolean | |
restrict_member_access |
boolean | |
paused |
boolean | |
endpoints |
array of objects | |
endpoints.uuid |
string (uuid) | |
endpoints.name |
string | |
endpoints.url |
string | URL of the access endpoint |
error_message |
string | |
error_traceback |
string | |
options |
any | |
available_actions |
array of strings | |
last_sync |
string (date-time) | |
order_in_progress |
any | |
creation_order |
any | |
service_settings_uuid |
string (uuid) | |
project_slug |
string | |
customer_slug |
string | |
user_requires_reconsent |
boolean | Check if the current user needs to re-consent for this resource's offering. |
renewal_date |
object (free-form) | |
offering_state |
any | |
offering_components |
array of objects | |
offering_components.uuid |
string (uuid) | |
offering_components.billing_type |
string | Enum: fixed, usage, limit, one, few |
offering_components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
offering_components.name |
string | Display name for the measured unit, for example, Floating IP. |
offering_components.description |
string | |
offering_components.measured_unit |
string | Unit of measurement, for example, GB. |
offering_components.unit_factor |
integer | The conversion factor from backend units to measured_unit |
offering_components.limit_period |
any | |
offering_components.limit_amount |
integer | |
offering_components.article_code |
string | |
offering_components.max_value |
integer | |
offering_components.min_value |
integer | |
offering_components.max_available_limit |
integer | |
offering_components.is_boolean |
boolean | |
offering_components.default_limit |
integer | |
offering_components.factor |
integer | |
offering_components.is_builtin |
boolean | |
offering_components.is_prepaid |
boolean | |
offering_components.overage_component |
string (uuid) | |
offering_components.min_prepaid_duration |
integer | |
offering_components.max_prepaid_duration |
integer | |
created_by |
string (uri) | |
created_by_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
created_by_full_name |
string | |
consumer_reviewed_by |
string (uri) | |
consumer_reviewed_by_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
consumer_reviewed_by_full_name |
string | |
slots |
array of objects | |
slots.start |
string (date-time) | |
slots.end |
string (date-time) | |
slots.backend_id |
string |
Other Actions
Accept
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
booking_resources_accept
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - No response body
Reject
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
booking_resources_reject
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - No response body
Categories
Marketplace Categories
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/marketplace-categories/ |
List categories |
| GET | /api/marketplace-categories/{uuid}/ |
Retrieve a category |
| POST | /api/marketplace-categories/ |
Create a category |
| PUT | /api/marketplace-categories/{uuid}/ |
Update a category |
| PATCH | /api/marketplace-categories/{uuid}/ |
Partially update a category |
| DELETE | /api/marketplace-categories/{uuid}/ |
Delete a category |
List categories
Returns a paginated list of marketplace categories.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- Model Source:
MaintenanceTypeEnum - Model Source:
MarketplaceCategoryFieldEnum - API Source:
marketplace_categories_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
customer_uuid |
string (uuid) | Customer UUID |
customers_offerings_state |
array | Customers offerings state |
field |
array | |
group_uuid |
string (uuid) | Category group UUID |
has_shared |
boolean | Has shared |
offering_name |
string | Offering name contains |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
resource_customer_uuid |
string (uuid) | Resource customer UUID |
resource_project_uuid |
string (uuid) | Resource project UUID |
title |
string | Title contains |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
title |
string | |
description |
string | |
icon |
string (uri) | |
default_vm_category |
boolean | Set to "true" if this category is for OpenStack VM. Only one category can have "true" value. |
default_volume_category |
boolean | Set to true if this category is for OpenStack Volume. Only one category can have "true" value. |
default_tenant_category |
boolean | Set to true if this category is for OpenStack Tenant. Only one category can have "true" value. |
offering_count |
integer | |
available_offerings_count |
integer | |
sections |
array of objects | |
sections.key |
string | |
sections.title |
string | |
sections.attributes |
array of objects | |
sections.attributes.key |
string | |
sections.attributes.title |
string | |
sections.attributes.type |
string | Enum: boolean, string, text, integer, choice, list |
sections.attributes.options |
array of objects | |
sections.attributes.options.key |
string | |
sections.attributes.options.title |
string | |
sections.attributes.required |
boolean | A value must be provided for the attribute. |
sections.attributes.default |
any | |
sections.is_standalone |
boolean | Whether section is rendered as a separate tab. |
columns |
array of objects | |
columns.uuid |
string (uuid) | |
columns.index |
integer | Index allows to reorder columns. |
columns.title |
string | Title is rendered as column header. |
columns.attribute |
string | Resource attribute is rendered as table cell. |
columns.widget |
any | Widget field allows to customise table cell rendering. |
components |
array of objects | |
components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
components.name |
string | Display name for the measured unit, for example, Floating IP. |
components.description |
string | |
components.measured_unit |
string | Unit of measurement, for example, GB. |
articles |
array of objects | |
articles.title |
string | |
articles.url |
string (uri) | |
group |
string (uri) |
Retrieve a category
Returns details of a specific marketplace category.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
MarketplaceCategoryFieldEnum - API Source:
marketplace_categories_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
title |
string | |
description |
string | |
icon |
string (uri) | |
default_vm_category |
boolean | Set to "true" if this category is for OpenStack VM. Only one category can have "true" value. |
default_volume_category |
boolean | Set to true if this category is for OpenStack Volume. Only one category can have "true" value. |
default_tenant_category |
boolean | Set to true if this category is for OpenStack Tenant. Only one category can have "true" value. |
offering_count |
integer | |
available_offerings_count |
integer | |
sections |
array of objects | |
sections.key |
string | |
sections.title |
string | |
sections.attributes |
array of objects | |
sections.attributes.key |
string | |
sections.attributes.title |
string | |
sections.attributes.type |
string | Enum: boolean, string, text, integer, choice, list |
sections.attributes.options |
array of objects | |
sections.attributes.options.key |
string | |
sections.attributes.options.title |
string | |
sections.attributes.required |
boolean | A value must be provided for the attribute. |
sections.attributes.default |
any | |
sections.is_standalone |
boolean | Whether section is rendered as a separate tab. |
columns |
array of objects | |
columns.uuid |
string (uuid) | |
columns.index |
integer | Index allows to reorder columns. |
columns.title |
string | Title is rendered as column header. |
columns.attribute |
string | Resource attribute is rendered as table cell. |
columns.widget |
any | Widget field allows to customise table cell rendering. |
components |
array of objects | |
components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
components.name |
string | Display name for the measured unit, for example, Floating IP. |
components.description |
string | |
components.measured_unit |
string | Unit of measurement, for example, GB. |
articles |
array of objects | |
articles.title |
string | |
articles.url |
string (uri) | |
group |
string (uri) |
Create a category
Creates a new marketplace category. Requires staff permissions.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
- Model Source:
MarketplaceCategoryRequest - API Source:
marketplace_categories_create
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Field | Type | Required | Description |
|---|---|---|---|
title |
string | ✓ | |
description |
string | ||
icon |
string (binary) | ||
default_vm_category |
boolean | Set to "true" if this category is for OpenStack VM. Only one category can have "true" value. | |
default_volume_category |
boolean | Set to true if this category is for OpenStack Volume. Only one category can have "true" value. | |
default_tenant_category |
boolean | Set to true if this category is for OpenStack Tenant. Only one category can have "true" value. | |
group |
string (uri) |
201 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
title |
string | |
description |
string | |
icon |
string (uri) | |
default_vm_category |
boolean | Set to "true" if this category is for OpenStack VM. Only one category can have "true" value. |
default_volume_category |
boolean | Set to true if this category is for OpenStack Volume. Only one category can have "true" value. |
default_tenant_category |
boolean | Set to true if this category is for OpenStack Tenant. Only one category can have "true" value. |
offering_count |
integer | |
available_offerings_count |
integer | |
sections |
array of objects | |
sections.key |
string | |
sections.title |
string | |
sections.attributes |
array of objects | |
sections.attributes.key |
string | |
sections.attributes.title |
string | |
sections.attributes.type |
string | Enum: boolean, string, text, integer, choice, list |
sections.attributes.options |
array of objects | |
sections.attributes.options.key |
string | |
sections.attributes.options.title |
string | |
sections.attributes.required |
boolean | A value must be provided for the attribute. |
sections.attributes.default |
any | |
sections.is_standalone |
boolean | Whether section is rendered as a separate tab. |
columns |
array of objects | |
columns.uuid |
string (uuid) | |
columns.index |
integer | Index allows to reorder columns. |
columns.title |
string | Title is rendered as column header. |
columns.attribute |
string | Resource attribute is rendered as table cell. |
columns.widget |
any | Widget field allows to customise table cell rendering. |
components |
array of objects | |
components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
components.name |
string | Display name for the measured unit, for example, Floating IP. |
components.description |
string | |
components.measured_unit |
string | Unit of measurement, for example, GB. |
articles |
array of objects | |
articles.title |
string | |
articles.url |
string (uri) | |
group |
string (uri) |
Update a category
Updates an existing marketplace category. Requires staff permissions.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
MarketplaceCategoryRequest - API Source:
marketplace_categories_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
title |
string | ✓ | |
description |
string | ||
icon |
string (binary) | ||
default_vm_category |
boolean | Set to "true" if this category is for OpenStack VM. Only one category can have "true" value. | |
default_volume_category |
boolean | Set to true if this category is for OpenStack Volume. Only one category can have "true" value. | |
default_tenant_category |
boolean | Set to true if this category is for OpenStack Tenant. Only one category can have "true" value. | |
group |
string (uri) |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
title |
string | |
description |
string | |
icon |
string (uri) | |
default_vm_category |
boolean | Set to "true" if this category is for OpenStack VM. Only one category can have "true" value. |
default_volume_category |
boolean | Set to true if this category is for OpenStack Volume. Only one category can have "true" value. |
default_tenant_category |
boolean | Set to true if this category is for OpenStack Tenant. Only one category can have "true" value. |
offering_count |
integer | |
available_offerings_count |
integer | |
sections |
array of objects | |
sections.key |
string | |
sections.title |
string | |
sections.attributes |
array of objects | |
sections.attributes.key |
string | |
sections.attributes.title |
string | |
sections.attributes.type |
string | Enum: boolean, string, text, integer, choice, list |
sections.attributes.options |
array of objects | |
sections.attributes.options.key |
string | |
sections.attributes.options.title |
string | |
sections.attributes.required |
boolean | A value must be provided for the attribute. |
sections.attributes.default |
any | |
sections.is_standalone |
boolean | Whether section is rendered as a separate tab. |
columns |
array of objects | |
columns.uuid |
string (uuid) | |
columns.index |
integer | Index allows to reorder columns. |
columns.title |
string | Title is rendered as column header. |
columns.attribute |
string | Resource attribute is rendered as table cell. |
columns.widget |
any | Widget field allows to customise table cell rendering. |
components |
array of objects | |
components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
components.name |
string | Display name for the measured unit, for example, Floating IP. |
components.description |
string | |
components.measured_unit |
string | Unit of measurement, for example, GB. |
articles |
array of objects | |
articles.title |
string | |
articles.url |
string (uri) | |
group |
string (uri) |
Partially update a category
Partially updates an existing marketplace category. Requires staff permissions.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedMarketplaceCategoryRequest - API Source:
marketplace_categories_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
title |
string | ||
description |
string | ||
icon |
string (binary) | ||
default_vm_category |
boolean | Set to "true" if this category is for OpenStack VM. Only one category can have "true" value. | |
default_volume_category |
boolean | Set to true if this category is for OpenStack Volume. Only one category can have "true" value. | |
default_tenant_category |
boolean | Set to true if this category is for OpenStack Tenant. Only one category can have "true" value. | |
group |
string (uri) |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
title |
string | |
description |
string | |
icon |
string (uri) | |
default_vm_category |
boolean | Set to "true" if this category is for OpenStack VM. Only one category can have "true" value. |
default_volume_category |
boolean | Set to true if this category is for OpenStack Volume. Only one category can have "true" value. |
default_tenant_category |
boolean | Set to true if this category is for OpenStack Tenant. Only one category can have "true" value. |
offering_count |
integer | |
available_offerings_count |
integer | |
sections |
array of objects | |
sections.key |
string | |
sections.title |
string | |
sections.attributes |
array of objects | |
sections.attributes.key |
string | |
sections.attributes.title |
string | |
sections.attributes.type |
string | Enum: boolean, string, text, integer, choice, list |
sections.attributes.options |
array of objects | |
sections.attributes.options.key |
string | |
sections.attributes.options.title |
string | |
sections.attributes.required |
boolean | A value must be provided for the attribute. |
sections.attributes.default |
any | |
sections.is_standalone |
boolean | Whether section is rendered as a separate tab. |
columns |
array of objects | |
columns.uuid |
string (uuid) | |
columns.index |
integer | Index allows to reorder columns. |
columns.title |
string | Title is rendered as column header. |
columns.attribute |
string | Resource attribute is rendered as table cell. |
columns.widget |
any | Widget field allows to customise table cell rendering. |
components |
array of objects | |
components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
components.name |
string | Display name for the measured unit, for example, Floating IP. |
components.description |
string | |
components.measured_unit |
string | Unit of measurement, for example, GB. |
articles |
array of objects | |
articles.title |
string | |
articles.url |
string (uri) | |
group |
string (uri) |
Delete a category
Deletes a marketplace category. Requires staff permissions.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_categories_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Marketplace Category Columns
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/marketplace-category-columns/ |
List category columns |
| GET | /api/marketplace-category-columns/{uuid}/ |
Retrieve a category column |
| POST | /api/marketplace-category-columns/ |
Create a category column |
| PUT | /api/marketplace-category-columns/{uuid}/ |
Update a category column |
| PATCH | /api/marketplace-category-columns/{uuid}/ |
Partially update a category column |
| DELETE | /api/marketplace-category-columns/{uuid}/ |
Delete a category column |
List category columns
Returns a paginated list of category columns used for resource table rendering.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
marketplace_category_columns_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
category_uuid |
string (uuid) | Category UUID |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
title |
string | Title contains |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
index |
integer | Index allows to reorder columns. |
title |
string | Title is rendered as column header. |
attribute |
string | Resource attribute is rendered as table cell. |
widget |
any | Widget field allows to customise table cell rendering. |
category |
string (uri) |
Retrieve a category column
Returns details of a specific category column.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_category_columns_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
index |
integer | Index allows to reorder columns. |
title |
string | Title is rendered as column header. |
attribute |
string | Resource attribute is rendered as table cell. |
widget |
any | Widget field allows to customise table cell rendering. |
category |
string (uri) |
Create a category column
Creates a new category column. Requires staff permissions.
1 2 3 4 5 6 7 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
CategoryColumnRequest - API Source:
marketplace_category_columns_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
| Field | Type | Required | Description |
|---|---|---|---|
index |
integer | ✓ | Index allows to reorder columns. |
title |
string | ✓ | Title is rendered as column header. |
attribute |
string | Resource attribute is rendered as table cell. | |
widget |
any | Widget field allows to customise table cell rendering. | |
category |
string (uri) | ✓ |
201 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
index |
integer | Index allows to reorder columns. |
title |
string | Title is rendered as column header. |
attribute |
string | Resource attribute is rendered as table cell. |
widget |
any | Widget field allows to customise table cell rendering. |
category |
string (uri) |
Update a category column
Updates an existing category column. Requires staff permissions.
1 2 3 4 5 6 7 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | |
- Model Source:
CategoryColumnRequest - API Source:
marketplace_category_columns_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
index |
integer | ✓ | Index allows to reorder columns. |
title |
string | ✓ | Title is rendered as column header. |
attribute |
string | Resource attribute is rendered as table cell. | |
widget |
any | Widget field allows to customise table cell rendering. | |
category |
string (uri) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
index |
integer | Index allows to reorder columns. |
title |
string | Title is rendered as column header. |
attribute |
string | Resource attribute is rendered as table cell. |
widget |
any | Widget field allows to customise table cell rendering. |
category |
string (uri) |
Partially update a category column
Partially updates an existing category column. Requires staff permissions.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedCategoryColumnRequest - API Source:
marketplace_category_columns_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
index |
integer | Index allows to reorder columns. | |
title |
string | Title is rendered as column header. | |
attribute |
string | Resource attribute is rendered as table cell. | |
widget |
any | Widget field allows to customise table cell rendering. | |
category |
string (uri) |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
index |
integer | Index allows to reorder columns. |
title |
string | Title is rendered as column header. |
attribute |
string | Resource attribute is rendered as table cell. |
widget |
any | Widget field allows to customise table cell rendering. |
category |
string (uri) |
Delete a category column
Deletes a category column. Requires staff permissions.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_category_columns_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Marketplace Category Components
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/marketplace-category-components/ |
List category components |
| GET | /api/marketplace-category-components/{id}/ |
Retrieve a category component |
| POST | /api/marketplace-category-components/ |
Create a category component |
| PUT | /api/marketplace-category-components/{id}/ |
Update a category component |
| PATCH | /api/marketplace-category-components/{id}/ |
Partially update a category component |
| DELETE | /api/marketplace-category-components/{id}/ |
Delete a category component |
List category components
Returns a paginated list of all components defined at the category level. These act as templates for components in offerings.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
marketplace_category_components_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
type |
string | Unique internal name of the measured unit, for example floating_ip. |
name |
string | Display name for the measured unit, for example, Floating IP. |
description |
string | |
measured_unit |
string | Unit of measurement, for example, GB. |
category |
object | |
category.url |
string (uri) | |
category.uuid |
string (uuid) | |
category.title |
string |
Retrieve a category component
Returns the details of a specific category component, identified by its ID.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_category_components_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required | Description |
|---|---|---|---|
id |
integer | ✓ | A unique integer value identifying this category component. |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
type |
string | Unique internal name of the measured unit, for example floating_ip. |
name |
string | Display name for the measured unit, for example, Floating IP. |
description |
string | |
measured_unit |
string | Unit of measurement, for example, GB. |
category |
object | |
category.url |
string (uri) | |
category.uuid |
string (uuid) | |
category.title |
string |
Create a category component
Creates a new component for a category. Requires staff permissions.
1 2 3 4 5 6 7 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
CategoryComponentsRequest - API Source:
marketplace_category_components_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
| Field | Type | Required | Description |
|---|---|---|---|
type |
string | ✓ | Unique internal name of the measured unit, for example floating_ip. |
name |
string | ✓ | Display name for the measured unit, for example, Floating IP. |
description |
string | ||
measured_unit |
string | Unit of measurement, for example, GB. | |
category |
object | ✓ | |
category.title |
string | ✓ |
201 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
type |
string | Unique internal name of the measured unit, for example floating_ip. |
name |
string | Display name for the measured unit, for example, Floating IP. |
description |
string | |
measured_unit |
string | Unit of measurement, for example, GB. |
category |
object | |
category.url |
string (uri) | |
category.uuid |
string (uuid) | |
category.title |
string |
Update a category component
Updates an existing category component. Requires staff permissions.
1 2 3 4 5 6 7 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | |
- Model Source:
CategoryComponentsRequest - API Source:
marketplace_category_components_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
| Name | Type | Required | Description |
|---|---|---|---|
id |
integer | ✓ | A unique integer value identifying this category component. |
| Field | Type | Required | Description |
|---|---|---|---|
type |
string | ✓ | Unique internal name of the measured unit, for example floating_ip. |
name |
string | ✓ | Display name for the measured unit, for example, Floating IP. |
description |
string | ||
measured_unit |
string | Unit of measurement, for example, GB. | |
category |
object | ✓ | |
category.title |
string | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
type |
string | Unique internal name of the measured unit, for example floating_ip. |
name |
string | Display name for the measured unit, for example, Floating IP. |
description |
string | |
measured_unit |
string | Unit of measurement, for example, GB. |
category |
object | |
category.url |
string (uri) | |
category.uuid |
string (uuid) | |
category.title |
string |
Partially update a category component
Partially updates an existing category component. Requires staff permissions.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedCategoryComponentsRequest - API Source:
marketplace_category_components_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required | Description |
|---|---|---|---|
id |
integer | ✓ | A unique integer value identifying this category component. |
| Field | Type | Required | Description |
|---|---|---|---|
type |
string | Unique internal name of the measured unit, for example floating_ip. | |
name |
string | Display name for the measured unit, for example, Floating IP. | |
description |
string | ||
measured_unit |
string | Unit of measurement, for example, GB. | |
category |
object | ||
category.title |
string | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
type |
string | Unique internal name of the measured unit, for example floating_ip. |
name |
string | Display name for the measured unit, for example, Floating IP. |
description |
string | |
measured_unit |
string | Unit of measurement, for example, GB. |
category |
object | |
category.url |
string (uri) | |
category.uuid |
string (uuid) | |
category.title |
string |
Delete a category component
Deletes a category component. Requires staff permissions.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_category_components_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required | Description |
|---|---|---|---|
id |
integer | ✓ | A unique integer value identifying this category component. |
204 - No response body
Marketplace Category Groups
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/marketplace-category-groups/ |
List category groups |
| GET | /api/marketplace-category-groups/{uuid}/ |
Retrieve a category group |
| POST | /api/marketplace-category-groups/ |
Create a category group |
| PUT | /api/marketplace-category-groups/{uuid}/ |
Update a category group |
| PATCH | /api/marketplace-category-groups/{uuid}/ |
Partially update a category group |
| DELETE | /api/marketplace-category-groups/{uuid}/ |
Delete a category group |
List category groups
Returns a paginated list of category groups.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 | |
- Model Source:
CategoryGroupFieldEnum - API Source:
marketplace_category_groups_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
field |
array | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
title |
string |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
title |
string |
description |
string |
icon |
string (uri) |
Retrieve a category group
Returns details of a specific category group.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
CategoryGroupFieldEnum - API Source:
marketplace_category_groups_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
title |
string |
description |
string |
icon |
string (uri) |
Create a category group
Creates a new category group. Requires staff permissions.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
- Model Source:
CategoryGroupRequest - API Source:
marketplace_category_groups_create
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Field | Type | Required |
|---|---|---|
title |
string | ✓ |
description |
string | |
icon |
string (binary) |
201 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
title |
string |
description |
string |
icon |
string (uri) |
Update a category group
Updates an existing category group. Requires staff permissions.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
CategoryGroupRequest - API Source:
marketplace_category_groups_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
title |
string | ✓ |
description |
string | |
icon |
string (binary) |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
title |
string |
description |
string |
icon |
string (uri) |
Partially update a category group
Partially updates an existing category group. Requires staff permissions.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedCategoryGroupRequest - API Source:
marketplace_category_groups_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
title |
string | |
description |
string | |
icon |
string (binary) |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
title |
string |
description |
string |
icon |
string (uri) |
Delete a category group
Deletes a category group. Requires staff permissions.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_category_groups_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Marketplace Category Help Articles
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/marketplace-category-help-articles/ |
List category help articles |
| GET | /api/marketplace-category-help-articles/{id}/ |
Retrieve a category help article |
| POST | /api/marketplace-category-help-articles/ |
Create a category help article |
| PUT | /api/marketplace-category-help-articles/{id}/ |
Update a category help article |
| PATCH | /api/marketplace-category-help-articles/{id}/ |
Partially update a category help article |
| DELETE | /api/marketplace-category-help-articles/{id}/ |
Delete a category help article |
List category help articles
Returns a paginated list of all help articles associated with marketplace categories.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
marketplace_category_help_articles_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
title |
string |
url |
string (uri) |
categories |
array of objects |
categories.url |
string (uri) |
categories.uuid |
string (uuid) |
categories.title |
string |
Retrieve a category help article
Returns the details of a specific help article, identified by its ID.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_category_help_articles_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required | Description |
|---|---|---|---|
id |
integer | ✓ | A unique integer value identifying this category help article. |
200 -
| Field | Type |
|---|---|
title |
string |
url |
string (uri) |
categories |
array of objects |
categories.url |
string (uri) |
categories.uuid |
string (uuid) |
categories.title |
string |
Create a category help article
Creates a new help article and associates it with one or more categories. Requires staff permissions.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
CategoryHelpArticlesRequest - API Source:
marketplace_category_help_articles_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Field | Type | Required |
|---|---|---|
title |
string | |
url |
string (uri) | ✓ |
categories |
array of objects | ✓ |
categories.title |
string | ✓ |
201 -
| Field | Type |
|---|---|
title |
string |
url |
string (uri) |
categories |
array of objects |
categories.url |
string (uri) |
categories.uuid |
string (uuid) |
categories.title |
string |
Update a category help article
Updates an existing help article. Requires staff permissions.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
CategoryHelpArticlesRequest - API Source:
marketplace_category_help_articles_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required | Description |
|---|---|---|---|
id |
integer | ✓ | A unique integer value identifying this category help article. |
| Field | Type | Required |
|---|---|---|
title |
string | |
url |
string (uri) | ✓ |
categories |
array of objects | ✓ |
categories.title |
string | ✓ |
200 -
| Field | Type |
|---|---|
title |
string |
url |
string (uri) |
categories |
array of objects |
categories.url |
string (uri) |
categories.uuid |
string (uuid) |
categories.title |
string |
Partially update a category help article
Partially updates an existing help article. Requires staff permissions.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedCategoryHelpArticlesRequest - API Source:
marketplace_category_help_articles_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required | Description |
|---|---|---|---|
id |
integer | ✓ | A unique integer value identifying this category help article. |
| Field | Type | Required |
|---|---|---|
title |
string | |
url |
string (uri) | |
categories |
array of objects | |
categories.title |
string | ✓ |
200 -
| Field | Type |
|---|---|
title |
string |
url |
string (uri) |
categories |
array of objects |
categories.url |
string (uri) |
categories.uuid |
string (uuid) |
categories.title |
string |
Delete a category help article
Deletes a help article. Requires staff permissions.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_category_help_articles_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required | Description |
|---|---|---|---|
id |
integer | ✓ | A unique integer value identifying this category help article. |
204 - No response body
Marketplace Global Categories
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/marketplace-global-categories/ |
Get resource counts by category |
Get resource counts by category
1 2 3 4 5 | |
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
- API Source:
marketplace_global_categories_retrieve
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
customer_uuid |
string (uuid) | Filter counts by resources within a specific customer. |
project_uuid |
string (uuid) | Filter counts by resources within a specific project. |
200 -
Marketplace Sections
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/marketplace-sections/ |
List sections |
| GET | /api/marketplace-sections/{key}/ |
Retrieve a section |
| POST | /api/marketplace-sections/ |
Create a section |
| PUT | /api/marketplace-sections/{key}/ |
Update a section |
| PATCH | /api/marketplace-sections/{key}/ |
Partially update a section |
| DELETE | /api/marketplace-sections/{key}/ |
Delete a section |
List sections
Returns a paginated list of all sections. Sections are used to group attributes within a category.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
marketplace_sections_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
key |
string | |
created |
string (date-time) | |
title |
string | |
category |
string (uri) | |
category_title |
string | |
is_standalone |
boolean | Whether section is rendered as a separate tab. |
Retrieve a section
Returns the details of a specific section, identified by its key.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_sections_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required | Description |
|---|---|---|---|
key |
string | ✓ | A unique value identifying this section. |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
key |
string | |
created |
string (date-time) | |
title |
string | |
category |
string (uri) | |
category_title |
string | |
is_standalone |
boolean | Whether section is rendered as a separate tab. |
Create a section
Creates a new section within a category. Requires staff permissions.
1 2 3 4 5 6 7 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
SectionRequest - API Source:
marketplace_sections_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
| Field | Type | Required | Description |
|---|---|---|---|
key |
string | ✓ | |
title |
string | ✓ | |
category |
string (uri) | ✓ | |
is_standalone |
boolean | Whether section is rendered as a separate tab. |
201 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
key |
string | |
created |
string (date-time) | |
title |
string | |
category |
string (uri) | |
category_title |
string | |
is_standalone |
boolean | Whether section is rendered as a separate tab. |
Update a section
Updates an existing section. Requires staff permissions.
1 2 3 4 5 6 7 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | |
- Model Source:
SectionRequest - API Source:
marketplace_sections_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
| Name | Type | Required | Description |
|---|---|---|---|
key |
string | ✓ | A unique value identifying this section. |
| Field | Type | Required | Description |
|---|---|---|---|
key |
string | ✓ | |
title |
string | ✓ | |
category |
string (uri) | ✓ | |
is_standalone |
boolean | Whether section is rendered as a separate tab. |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
key |
string | |
created |
string (date-time) | |
title |
string | |
category |
string (uri) | |
category_title |
string | |
is_standalone |
boolean | Whether section is rendered as a separate tab. |
Partially update a section
Partially updates an existing section. Requires staff permissions.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedSectionRequest - API Source:
marketplace_sections_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required | Description |
|---|---|---|---|
key |
string | ✓ | A unique value identifying this section. |
| Field | Type | Required | Description |
|---|---|---|---|
key |
string | ||
title |
string | ||
category |
string (uri) | ||
is_standalone |
boolean | Whether section is rendered as a separate tab. |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
key |
string | |
created |
string (date-time) | |
title |
string | |
category |
string (uri) | |
category_title |
string | |
is_standalone |
boolean | Whether section is rendered as a separate tab. |
Delete a section
Deletes a section. Requires staff permissions.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_sections_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required | Description |
|---|---|---|---|
key |
string | ✓ | A unique value identifying this section. |
204 - No response body
Checklists
Checklists Admin Question Dependencies
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/checklists-admin-question-dependencies/ |
List Checklists Admin Question Dependencies |
| GET | /api/checklists-admin-question-dependencies/{uuid}/ |
Retrieve |
| POST | /api/checklists-admin-question-dependencies/ |
Create |
| PUT | /api/checklists-admin-question-dependencies/{uuid}/ |
Update |
| PATCH | /api/checklists-admin-question-dependencies/{uuid}/ |
Partial Update |
| DELETE | /api/checklists-admin-question-dependencies/{uuid}/ |
Delete |
List Checklists Admin Question Dependencies
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
checklists_admin_question_dependencies_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
depends_on_question_uuid |
string (uuid) | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
question_uuid |
string (uuid) |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
question |
string (uri) | |
question_name |
string | |
depends_on_question |
string (uri) | |
depends_on_question_name |
string | |
required_answer_value |
any | The answer value(s) that make this question visible |
operator |
string | Enum: equals, not_equals, contains, in, not_in |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
checklists_admin_question_dependencies_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
question |
string (uri) | |
question_name |
string | |
depends_on_question |
string (uri) | |
depends_on_question_name |
string | |
required_answer_value |
any | The answer value(s) that make this question visible |
operator |
string | Enum: equals, not_equals, contains, in, not_in |
Create
1 2 3 4 5 6 7 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
QuestionDependencyRequest - API Source:
checklists_admin_question_dependencies_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
| Field | Type | Required | Description |
|---|---|---|---|
question |
string (uri) | ✓ | |
depends_on_question |
string (uri) | ✓ | |
required_answer_value |
any | ✓ | The answer value(s) that make this question visible |
operator |
string | Enum: equals, not_equals, contains, in, not_in |
201 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
question |
string (uri) | |
question_name |
string | |
depends_on_question |
string (uri) | |
depends_on_question_name |
string | |
required_answer_value |
any | The answer value(s) that make this question visible |
operator |
string | Enum: equals, not_equals, contains, in, not_in |
Update
1 2 3 4 5 6 7 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | |
- Model Source:
QuestionDependencyRequest - API Source:
checklists_admin_question_dependencies_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
question |
string (uri) | ✓ | |
depends_on_question |
string (uri) | ✓ | |
required_answer_value |
any | ✓ | The answer value(s) that make this question visible |
operator |
string | Enum: equals, not_equals, contains, in, not_in |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
question |
string (uri) | |
question_name |
string | |
depends_on_question |
string (uri) | |
depends_on_question_name |
string | |
required_answer_value |
any | The answer value(s) that make this question visible |
operator |
string | Enum: equals, not_equals, contains, in, not_in |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedQuestionDependencyRequest - API Source:
checklists_admin_question_dependencies_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
question |
string (uri) | ||
depends_on_question |
string (uri) | ||
required_answer_value |
any | The answer value(s) that make this question visible | |
operator |
string | Enum: equals, not_equals, contains, in, not_in |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
question |
string (uri) | |
question_name |
string | |
depends_on_question |
string (uri) | |
depends_on_question_name |
string | |
required_answer_value |
any | The answer value(s) that make this question visible |
operator |
string | Enum: equals, not_equals, contains, in, not_in |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
checklists_admin_question_dependencies_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Checklists Admin Question Options
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/checklists-admin-question-options/ |
List Checklists Admin Question Options |
| GET | /api/checklists-admin-question-options/{uuid}/ |
Retrieve |
| POST | /api/checklists-admin-question-options/ |
Create |
| PUT | /api/checklists-admin-question-options/{uuid}/ |
Update |
| PATCH | /api/checklists-admin-question-options/{uuid}/ |
Partial Update |
| DELETE | /api/checklists-admin-question-options/{uuid}/ |
Delete |
List Checklists Admin Question Options
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
checklists_admin_question_options_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
question_uuid |
string (uuid) |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
uuid |
string (uuid) |
label |
string |
order |
integer |
url |
string (uri) |
question |
string (uri) |
question_uuid |
string (uuid) |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
checklists_admin_question_options_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
label |
string |
order |
integer |
url |
string (uri) |
question |
string (uri) |
question_uuid |
string (uuid) |
Create
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
QuestionOptionsAdminRequest - API Source:
checklists_admin_question_options_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Field | Type | Required |
|---|---|---|
label |
string | ✓ |
order |
integer | |
question |
string (uri) | ✓ |
201 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
label |
string |
order |
integer |
url |
string (uri) |
question |
string (uri) |
question_uuid |
string (uuid) |
Update
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
QuestionOptionsAdminRequest - API Source:
checklists_admin_question_options_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
label |
string | ✓ |
order |
integer | |
question |
string (uri) | ✓ |
200 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
label |
string |
order |
integer |
url |
string (uri) |
question |
string (uri) |
question_uuid |
string (uuid) |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedQuestionOptionsAdminRequest - API Source:
checklists_admin_question_options_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
label |
string | |
order |
integer |
200 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
label |
string |
order |
integer |
url |
string (uri) |
question |
string (uri) |
question_uuid |
string (uuid) |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
checklists_admin_question_options_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Checklists Admin Questions
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/checklists-admin-questions/ |
List Checklists Admin Questions |
| GET | /api/checklists-admin-questions/{uuid}/ |
Retrieve |
| POST | /api/checklists-admin-questions/ |
Create |
| PUT | /api/checklists-admin-questions/{uuid}/ |
Update |
| PATCH | /api/checklists-admin-questions/{uuid}/ |
Partial Update |
| DELETE | /api/checklists-admin-questions/{uuid}/ |
Delete |
List Checklists Admin Questions
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 | |
- Model Source:
ChecklistTypeEnum - API Source:
checklists_admin_questions_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
checklist_type |
string | Type of compliance this checklist addresses Enum: project_compliance, proposal_compliance, offering_compliance, project_metadata, onboarding_customer, onboarding_intent |
checklist_uuid |
string (uuid) | |
has_onboarding_mapping |
boolean | Filter questions that have onboarding metadata mapping |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
required |
boolean | |
description |
string | |
user_guidance |
string | Additional guidance text visible to users when answering and reviewing |
question_options |
array of objects | |
question_options.uuid |
string (uuid) | |
question_options.label |
string | |
question_options.order |
integer | |
question_options.url |
string (uri) | |
question_options.question |
string (uri) | |
question_options.question_uuid |
string (uuid) | |
question_type |
any | Type of question and expected answer format |
order |
integer | |
min_value |
string (decimal) | Minimum value allowed for NUMBER, YEAR, and RATING type questions |
max_value |
string (decimal) | Maximum value allowed for NUMBER, YEAR, and RATING type questions |
allowed_file_types |
any | List of allowed file extensions (e.g., ['.pdf', '.doc', '.docx']). If empty, all file types are allowed. |
allowed_mime_types |
any | List of allowed MIME types (e.g., ['application/pdf', 'application/msword']). If empty, MIME type validation is not enforced. When both extensions and MIME types are specified, files must match both criteria for security. |
max_file_size_mb |
integer | Maximum file size in megabytes. If not set, no size limit is enforced. |
max_files_count |
integer | Maximum number of files allowed for MULTIPLE_FILES type questions. If not set, no count limit is enforced. |
operator |
any | |
review_answer_value |
any | Answer value that trigger review. |
always_requires_review |
boolean | This question always requires review regardless of answer |
guidance_answer_value |
any | Answer value that triggers display of user guidance. |
guidance_operator |
any | Operator to use when comparing answer with guidance_answer_value |
always_show_guidance |
boolean | Show user guidance always, regardless of answer. If False, guidance is conditional on answer matching guidance_answer_value with guidance_operator |
dependency_logic_operator |
any | Defines how multiple dependencies are evaluated. AND: All dependencies must be satisfied. OR: At least one dependency must be satisfied. |
url |
string (uri) | |
checklist_name |
string | |
checklist_uuid |
string (uuid) | |
checklist_type |
string | |
checklist |
string (uri) |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
checklists_admin_questions_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
required |
boolean | |
description |
string | |
user_guidance |
string | Additional guidance text visible to users when answering and reviewing |
question_options |
array of objects | |
question_options.uuid |
string (uuid) | |
question_options.label |
string | |
question_options.order |
integer | |
question_options.url |
string (uri) | |
question_options.question |
string (uri) | |
question_options.question_uuid |
string (uuid) | |
question_type |
any | Type of question and expected answer format |
order |
integer | |
min_value |
string (decimal) | Minimum value allowed for NUMBER, YEAR, and RATING type questions |
max_value |
string (decimal) | Maximum value allowed for NUMBER, YEAR, and RATING type questions |
allowed_file_types |
any | List of allowed file extensions (e.g., ['.pdf', '.doc', '.docx']). If empty, all file types are allowed. |
allowed_mime_types |
any | List of allowed MIME types (e.g., ['application/pdf', 'application/msword']). If empty, MIME type validation is not enforced. When both extensions and MIME types are specified, files must match both criteria for security. |
max_file_size_mb |
integer | Maximum file size in megabytes. If not set, no size limit is enforced. |
max_files_count |
integer | Maximum number of files allowed for MULTIPLE_FILES type questions. If not set, no count limit is enforced. |
operator |
any | |
review_answer_value |
any | Answer value that trigger review. |
always_requires_review |
boolean | This question always requires review regardless of answer |
guidance_answer_value |
any | Answer value that triggers display of user guidance. |
guidance_operator |
any | Operator to use when comparing answer with guidance_answer_value |
always_show_guidance |
boolean | Show user guidance always, regardless of answer. If False, guidance is conditional on answer matching guidance_answer_value with guidance_operator |
dependency_logic_operator |
any | Defines how multiple dependencies are evaluated. AND: All dependencies must be satisfied. OR: At least one dependency must be satisfied. |
url |
string (uri) | |
checklist_name |
string | |
checklist_uuid |
string (uuid) | |
checklist_type |
string | |
checklist |
string (uri) |
Create
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
- Model Source:
QuestionAdminRequest - API Source:
checklists_admin_questions_create
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Field | Type | Required | Description |
|---|---|---|---|
required |
boolean | ||
description |
string | ||
user_guidance |
string | Additional guidance text visible to users when answering and reviewing | |
question_type |
any | Type of question and expected answer format | |
order |
integer | ||
min_value |
string (decimal) | Minimum value allowed for NUMBER, YEAR, and RATING type questions | |
max_value |
string (decimal) | Maximum value allowed for NUMBER, YEAR, and RATING type questions | |
allowed_file_types |
any | List of allowed file extensions (e.g., ['.pdf', '.doc', '.docx']). If empty, all file types are allowed. | |
allowed_mime_types |
any | List of allowed MIME types (e.g., ['application/pdf', 'application/msword']). If empty, MIME type validation is not enforced. When both extensions and MIME types are specified, files must match both criteria for security. | |
max_file_size_mb |
integer | Maximum file size in megabytes. If not set, no size limit is enforced. | |
max_files_count |
integer | Maximum number of files allowed for MULTIPLE_FILES type questions. If not set, no count limit is enforced. | |
operator |
any | ||
review_answer_value |
any | Answer value that trigger review. | |
always_requires_review |
boolean | This question always requires review regardless of answer | |
guidance_answer_value |
any | Answer value that triggers display of user guidance. | |
guidance_operator |
any | Operator to use when comparing answer with guidance_answer_value | |
always_show_guidance |
boolean | Show user guidance always, regardless of answer. If False, guidance is conditional on answer matching guidance_answer_value with guidance_operator | |
dependency_logic_operator |
any | Defines how multiple dependencies are evaluated. AND: All dependencies must be satisfied. OR: At least one dependency must be satisfied. | |
checklist |
string (uri) | ✓ |
201 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
required |
boolean | |
description |
string | |
user_guidance |
string | Additional guidance text visible to users when answering and reviewing |
question_options |
array of objects | |
question_options.uuid |
string (uuid) | |
question_options.label |
string | |
question_options.order |
integer | |
question_options.url |
string (uri) | |
question_options.question |
string (uri) | |
question_options.question_uuid |
string (uuid) | |
question_type |
any | Type of question and expected answer format |
order |
integer | |
min_value |
string (decimal) | Minimum value allowed for NUMBER, YEAR, and RATING type questions |
max_value |
string (decimal) | Maximum value allowed for NUMBER, YEAR, and RATING type questions |
allowed_file_types |
any | List of allowed file extensions (e.g., ['.pdf', '.doc', '.docx']). If empty, all file types are allowed. |
allowed_mime_types |
any | List of allowed MIME types (e.g., ['application/pdf', 'application/msword']). If empty, MIME type validation is not enforced. When both extensions and MIME types are specified, files must match both criteria for security. |
max_file_size_mb |
integer | Maximum file size in megabytes. If not set, no size limit is enforced. |
max_files_count |
integer | Maximum number of files allowed for MULTIPLE_FILES type questions. If not set, no count limit is enforced. |
operator |
any | |
review_answer_value |
any | Answer value that trigger review. |
always_requires_review |
boolean | This question always requires review regardless of answer |
guidance_answer_value |
any | Answer value that triggers display of user guidance. |
guidance_operator |
any | Operator to use when comparing answer with guidance_answer_value |
always_show_guidance |
boolean | Show user guidance always, regardless of answer. If False, guidance is conditional on answer matching guidance_answer_value with guidance_operator |
dependency_logic_operator |
any | Defines how multiple dependencies are evaluated. AND: All dependencies must be satisfied. OR: At least one dependency must be satisfied. |
url |
string (uri) | |
checklist_name |
string | |
checklist_uuid |
string (uuid) | |
checklist_type |
string | |
checklist |
string (uri) |
Update
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
QuestionAdminRequest - API Source:
checklists_admin_questions_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
required |
boolean | ||
description |
string | ||
user_guidance |
string | Additional guidance text visible to users when answering and reviewing | |
question_type |
any | Type of question and expected answer format | |
order |
integer | ||
min_value |
string (decimal) | Minimum value allowed for NUMBER, YEAR, and RATING type questions | |
max_value |
string (decimal) | Maximum value allowed for NUMBER, YEAR, and RATING type questions | |
allowed_file_types |
any | List of allowed file extensions (e.g., ['.pdf', '.doc', '.docx']). If empty, all file types are allowed. | |
allowed_mime_types |
any | List of allowed MIME types (e.g., ['application/pdf', 'application/msword']). If empty, MIME type validation is not enforced. When both extensions and MIME types are specified, files must match both criteria for security. | |
max_file_size_mb |
integer | Maximum file size in megabytes. If not set, no size limit is enforced. | |
max_files_count |
integer | Maximum number of files allowed for MULTIPLE_FILES type questions. If not set, no count limit is enforced. | |
operator |
any | ||
review_answer_value |
any | Answer value that trigger review. | |
always_requires_review |
boolean | This question always requires review regardless of answer | |
guidance_answer_value |
any | Answer value that triggers display of user guidance. | |
guidance_operator |
any | Operator to use when comparing answer with guidance_answer_value | |
always_show_guidance |
boolean | Show user guidance always, regardless of answer. If False, guidance is conditional on answer matching guidance_answer_value with guidance_operator | |
dependency_logic_operator |
any | Defines how multiple dependencies are evaluated. AND: All dependencies must be satisfied. OR: At least one dependency must be satisfied. | |
checklist |
string (uri) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
required |
boolean | |
description |
string | |
user_guidance |
string | Additional guidance text visible to users when answering and reviewing |
question_options |
array of objects | |
question_options.uuid |
string (uuid) | |
question_options.label |
string | |
question_options.order |
integer | |
question_options.url |
string (uri) | |
question_options.question |
string (uri) | |
question_options.question_uuid |
string (uuid) | |
question_type |
any | Type of question and expected answer format |
order |
integer | |
min_value |
string (decimal) | Minimum value allowed for NUMBER, YEAR, and RATING type questions |
max_value |
string (decimal) | Maximum value allowed for NUMBER, YEAR, and RATING type questions |
allowed_file_types |
any | List of allowed file extensions (e.g., ['.pdf', '.doc', '.docx']). If empty, all file types are allowed. |
allowed_mime_types |
any | List of allowed MIME types (e.g., ['application/pdf', 'application/msword']). If empty, MIME type validation is not enforced. When both extensions and MIME types are specified, files must match both criteria for security. |
max_file_size_mb |
integer | Maximum file size in megabytes. If not set, no size limit is enforced. |
max_files_count |
integer | Maximum number of files allowed for MULTIPLE_FILES type questions. If not set, no count limit is enforced. |
operator |
any | |
review_answer_value |
any | Answer value that trigger review. |
always_requires_review |
boolean | This question always requires review regardless of answer |
guidance_answer_value |
any | Answer value that triggers display of user guidance. |
guidance_operator |
any | Operator to use when comparing answer with guidance_answer_value |
always_show_guidance |
boolean | Show user guidance always, regardless of answer. If False, guidance is conditional on answer matching guidance_answer_value with guidance_operator |
dependency_logic_operator |
any | Defines how multiple dependencies are evaluated. AND: All dependencies must be satisfied. OR: At least one dependency must be satisfied. |
url |
string (uri) | |
checklist_name |
string | |
checklist_uuid |
string (uuid) | |
checklist_type |
string | |
checklist |
string (uri) |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedQuestionAdminRequest - API Source:
checklists_admin_questions_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
required |
boolean | ||
description |
string | ||
user_guidance |
string | Additional guidance text visible to users when answering and reviewing | |
question_type |
any | Type of question and expected answer format | |
order |
integer | ||
min_value |
string (decimal) | Minimum value allowed for NUMBER, YEAR, and RATING type questions | |
max_value |
string (decimal) | Maximum value allowed for NUMBER, YEAR, and RATING type questions | |
allowed_file_types |
any | List of allowed file extensions (e.g., ['.pdf', '.doc', '.docx']). If empty, all file types are allowed. | |
allowed_mime_types |
any | List of allowed MIME types (e.g., ['application/pdf', 'application/msword']). If empty, MIME type validation is not enforced. When both extensions and MIME types are specified, files must match both criteria for security. | |
max_file_size_mb |
integer | Maximum file size in megabytes. If not set, no size limit is enforced. | |
max_files_count |
integer | Maximum number of files allowed for MULTIPLE_FILES type questions. If not set, no count limit is enforced. | |
operator |
any | ||
review_answer_value |
any | Answer value that trigger review. | |
always_requires_review |
boolean | This question always requires review regardless of answer | |
guidance_answer_value |
any | Answer value that triggers display of user guidance. | |
guidance_operator |
any | Operator to use when comparing answer with guidance_answer_value | |
always_show_guidance |
boolean | Show user guidance always, regardless of answer. If False, guidance is conditional on answer matching guidance_answer_value with guidance_operator | |
dependency_logic_operator |
any | Defines how multiple dependencies are evaluated. AND: All dependencies must be satisfied. OR: At least one dependency must be satisfied. | |
checklist |
string (uri) |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
required |
boolean | |
description |
string | |
user_guidance |
string | Additional guidance text visible to users when answering and reviewing |
question_options |
array of objects | |
question_options.uuid |
string (uuid) | |
question_options.label |
string | |
question_options.order |
integer | |
question_options.url |
string (uri) | |
question_options.question |
string (uri) | |
question_options.question_uuid |
string (uuid) | |
question_type |
any | Type of question and expected answer format |
order |
integer | |
min_value |
string (decimal) | Minimum value allowed for NUMBER, YEAR, and RATING type questions |
max_value |
string (decimal) | Maximum value allowed for NUMBER, YEAR, and RATING type questions |
allowed_file_types |
any | List of allowed file extensions (e.g., ['.pdf', '.doc', '.docx']). If empty, all file types are allowed. |
allowed_mime_types |
any | List of allowed MIME types (e.g., ['application/pdf', 'application/msword']). If empty, MIME type validation is not enforced. When both extensions and MIME types are specified, files must match both criteria for security. |
max_file_size_mb |
integer | Maximum file size in megabytes. If not set, no size limit is enforced. |
max_files_count |
integer | Maximum number of files allowed for MULTIPLE_FILES type questions. If not set, no count limit is enforced. |
operator |
any | |
review_answer_value |
any | Answer value that trigger review. |
always_requires_review |
boolean | This question always requires review regardless of answer |
guidance_answer_value |
any | Answer value that triggers display of user guidance. |
guidance_operator |
any | Operator to use when comparing answer with guidance_answer_value |
always_show_guidance |
boolean | Show user guidance always, regardless of answer. If False, guidance is conditional on answer matching guidance_answer_value with guidance_operator |
dependency_logic_operator |
any | Defines how multiple dependencies are evaluated. AND: All dependencies must be satisfied. OR: At least one dependency must be satisfied. |
url |
string (uri) | |
checklist_name |
string | |
checklist_uuid |
string (uuid) | |
checklist_type |
string | |
checklist |
string (uri) |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
checklists_admin_questions_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Checklists Admin
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/checklists-admin/ |
List Checklists Admin |
| GET | /api/checklists-admin/{uuid}/ |
Retrieve |
| POST | /api/checklists-admin/ |
Create |
| PUT | /api/checklists-admin/{uuid}/ |
Update |
| PATCH | /api/checklists-admin/{uuid}/ |
Partial Update |
| DELETE | /api/checklists-admin/{uuid}/ |
Delete |
| Other Actions | ||
| GET | /api/checklists-admin/{uuid}/questions/ |
Return checklist questions |
Core CRUD
List Checklists Admin
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 | |
- Model Source:
ChecklistTypeEnum - API Source:
checklists_admin_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
checklist_type |
string | Type of compliance this checklist addresses Enum: project_compliance, proposal_compliance, offering_compliance, project_metadata, onboarding_customer, onboarding_intent |
checklist_type__in |
array | Filter by multiple checklist types |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
name |
string | |
description |
string | |
checklist_type |
any | Type of compliance this checklist addresses |
questions_count |
integer |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
checklists_admin_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
name |
string | |
description |
string | |
checklist_type |
any | Type of compliance this checklist addresses |
questions_count |
integer |
Create
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
- Model Source:
ChecklistRequest - API Source:
checklists_admin_create
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ✓ | |
description |
string | ||
checklist_type |
any | Type of compliance this checklist addresses |
201 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
name |
string | |
description |
string | |
checklist_type |
any | Type of compliance this checklist addresses |
questions_count |
integer |
Update
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
ChecklistRequest - API Source:
checklists_admin_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ✓ | |
description |
string | ||
checklist_type |
any | Type of compliance this checklist addresses |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
name |
string | |
description |
string | |
checklist_type |
any | Type of compliance this checklist addresses |
questions_count |
integer |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedChecklistRequest - API Source:
checklists_admin_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ||
description |
string | ||
checklist_type |
any | Type of compliance this checklist addresses |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
name |
string | |
description |
string | |
checklist_type |
any | Type of compliance this checklist addresses |
questions_count |
integer |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
checklists_admin_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
Return checklist questions
Return checklist questions.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
- Model Source:
ChecklistTypeEnum - API Source:
checklists_admin_checklist_questions
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
checklist_type |
string | Type of compliance this checklist addresses Enum: project_compliance, proposal_compliance, offering_compliance, project_metadata, onboarding_customer, onboarding_intent |
checklist_type__in |
array | Filter by multiple checklist types |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
required |
boolean | |
description |
string | |
user_guidance |
string | Additional guidance text visible to users when answering and reviewing |
question_options |
array of objects | |
question_options.uuid |
string (uuid) | |
question_options.label |
string | |
question_options.order |
integer | |
question_options.url |
string (uri) | |
question_options.question |
string (uri) | |
question_options.question_uuid |
string (uuid) | |
question_type |
any | Type of question and expected answer format |
order |
integer | |
min_value |
string (decimal) | Minimum value allowed for NUMBER, YEAR, and RATING type questions |
max_value |
string (decimal) | Maximum value allowed for NUMBER, YEAR, and RATING type questions |
allowed_file_types |
any | List of allowed file extensions (e.g., ['.pdf', '.doc', '.docx']). If empty, all file types are allowed. |
allowed_mime_types |
any | List of allowed MIME types (e.g., ['application/pdf', 'application/msword']). If empty, MIME type validation is not enforced. When both extensions and MIME types are specified, files must match both criteria for security. |
max_file_size_mb |
integer | Maximum file size in megabytes. If not set, no size limit is enforced. |
max_files_count |
integer | Maximum number of files allowed for MULTIPLE_FILES type questions. If not set, no count limit is enforced. |
operator |
any | |
review_answer_value |
any | Answer value that trigger review. |
always_requires_review |
boolean | This question always requires review regardless of answer |
guidance_answer_value |
any | Answer value that triggers display of user guidance. |
guidance_operator |
any | Operator to use when comparing answer with guidance_answer_value |
always_show_guidance |
boolean | Show user guidance always, regardless of answer. If False, guidance is conditional on answer matching guidance_answer_value with guidance_operator |
dependency_logic_operator |
any | Defines how multiple dependencies are evaluated. AND: All dependencies must be satisfied. OR: At least one dependency must be satisfied. |
url |
string (uri) | |
checklist_name |
string | |
checklist_uuid |
string (uuid) | |
checklist_type |
string | |
checklist |
string (uri) |
Marketplace Offering User Checklist Completions
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/marketplace-offering-user-checklist-completions/ |
List checklist completions for offering users |
| GET | /api/marketplace-offering-user-checklist-completions/{id}/ |
Retrieve a checklist completion |
List checklist completions for offering users
1 2 3 | |
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 | |
- Model Source:
UserChecklistCompletionOEnum - API Source:
marketplace_offering_user_checklist_completions_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
created |
string (date-time) | Created after |
is_completed |
boolean | |
modified |
string (date-time) | Modified after |
o |
array | Ordering |
offering_uuid |
string (uuid) | Filter by offering UUID |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
user_uuid |
string (uuid) | Filter by user UUID |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
offering_user |
any | |
offering_user_uuid |
string | |
offering_name |
string | |
offering_uuid |
string | |
customer_provider_uuid |
string | |
customer_provider_name |
string | |
checklist_uuid |
string | |
checklist_name |
string | |
checklist_description |
string | |
is_completed |
boolean | Whether all required questions have been answered |
completion_percentage |
number (double) | |
unanswered_required_questions |
integer | |
requires_review |
boolean | Whether any answers triggered review requirements |
reviewed_by |
integer | User who reviewed the checklist completion |
reviewed_at |
string (date-time) | |
review_notes |
string | Notes from the reviewer |
created |
string (date-time) | |
modified |
string (date-time) |
Retrieve a checklist completion
Returns the details of a specific checklist completion for an offering user.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required | Description |
|---|---|---|---|
id |
integer | ✓ | A unique integer value identifying this Checklist completion. |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
offering_user |
any | |
offering_user_uuid |
string | |
offering_name |
string | |
offering_uuid |
string | |
customer_provider_uuid |
string | |
customer_provider_name |
string | |
checklist_uuid |
string | |
checklist_name |
string | |
checklist_description |
string | |
is_completed |
boolean | Whether all required questions have been answered |
completion_percentage |
number (double) | |
unanswered_required_questions |
integer | |
requires_review |
boolean | Whether any answers triggered review requirements |
reviewed_by |
integer | User who reviewed the checklist completion |
reviewed_at |
string (date-time) | |
review_notes |
string | Notes from the reviewer |
created |
string (date-time) | |
modified |
string (date-time) |
Integration
Marketplace Integration Statuses
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/marketplace-integration-statuses/ |
List integration statuses |
| GET | /api/marketplace-integration-statuses/{uuid}/ |
Retrieve an integration status |
List integration statuses
Returns a paginated list of integration statuses for offerings. This is used to monitor the connectivity and health of backend agents (e.g., site agents) associated with offerings.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- Model Source:
IntegrationStatusDetailsOEnum - Model Source:
IntegrationStatusDetailsStatusEnum - API Source:
marketplace_integration_statuses_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
agent_type |
string | Agent type |
customer_uuid |
string | Customer UUID |
o |
array | Ordering |
offering |
string (uri) | |
offering_slug |
array | Multiple values may be separated by commas. |
offering_uuid |
array | Multiple values may be separated by commas. |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
parent_offering_uuid |
string (uuid) | |
status |
array | Integration status |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
status |
string |
last_request_timestamp |
string (date-time) |
offering |
string (uri) |
url |
string (uri) |
Retrieve an integration status
Returns the details of a specific integration status, including the agent type, status, and last request timestamp.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_integration_statuses_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
status |
string |
last_request_timestamp |
string (date-time) |
offering |
string (uri) |
url |
string (uri) |
Marketplace Plugins
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/marketplace-plugins/ |
List available marketplace plugins and their components |
List available marketplace plugins and their components
1 2 3 4 5 6 7 | |
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
marketplace_plugins_list
1 2 3 4 5 6 7 8 9 10 | |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
offering_type |
string | |
components |
array of objects | |
components.type |
string | Type identifier of the component |
components.name |
string | Display name of the component |
components.measured_unit |
string | Unit of measurement for the component |
components.billing_type |
any | Billing type for the component |
available_limits |
array of strings |
Marketplace Project Update Requests
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/marketplace-project-update-requests/ |
List Marketplace Project Update Requests |
| GET | /api/marketplace-project-update-requests/{uuid}/ |
Retrieve |
| Other Actions | ||
| POST | /api/marketplace-project-update-requests/{uuid}/approve/ |
Approve project update request |
| POST | /api/marketplace-project-update-requests/{uuid}/reject/ |
Reject project update request |
Core CRUD
List Marketplace Project Update Requests
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 | |
- Model Source:
RemoteProjectUpdateRequestStateEnum - API Source:
marketplace_project_update_requests_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
customer_uuid |
string (uuid) | |
offering_uuid |
string (uuid) | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
project_uuid |
string (uuid) | |
provider_uuid |
string (uuid) | |
state |
array |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
state |
string | |
customer_name |
string | |
customer_uuid |
string | |
offering_name |
string | |
offering_uuid |
string (uuid) | |
created |
string (date-time) | |
reviewed_at |
string (date-time) | Timestamp when the review was completed |
reviewed_by_full_name |
string | |
reviewed_by_uuid |
string (uuid) | |
review_comment |
string | Optional comment provided during review |
old_name |
string | |
new_name |
string | |
old_description |
string | |
new_description |
string | |
old_end_date |
string (date) | |
new_end_date |
string (date) | |
old_oecd_fos_2007_code |
string | |
old_oecd_fos_2007_label |
string | |
new_oecd_fos_2007_code |
string | |
new_oecd_fos_2007_label |
string | |
old_is_industry |
boolean | |
new_is_industry |
boolean | |
created_by |
integer |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_project_update_requests_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
state |
string | |
customer_name |
string | |
customer_uuid |
string | |
offering_name |
string | |
offering_uuid |
string (uuid) | |
created |
string (date-time) | |
reviewed_at |
string (date-time) | Timestamp when the review was completed |
reviewed_by_full_name |
string | |
reviewed_by_uuid |
string (uuid) | |
review_comment |
string | Optional comment provided during review |
old_name |
string | |
new_name |
string | |
old_description |
string | |
new_description |
string | |
old_end_date |
string (date) | |
new_end_date |
string (date) | |
old_oecd_fos_2007_code |
string | |
old_oecd_fos_2007_label |
string | |
new_oecd_fos_2007_code |
string | |
new_oecd_fos_2007_label |
string | |
old_is_industry |
boolean | |
new_is_industry |
boolean | |
created_by |
integer |
Other Actions
Approve project update request
Approve project update request
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
ReviewCommentRequest - API Source:
marketplace_project_update_requests_approve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
comment |
string | Optional comment for review |
200 - No response body
Reject project update request
Reject project update request
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
ReviewCommentRequest - API Source:
marketplace_project_update_requests_reject
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
comment |
string | Optional comment for review |
200 - No response body
Marketplace Public Api
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| POST | /api/marketplace-public-api/check_signature/ |
Check service provider signature |
| POST | /api/marketplace-public-api/set_usage/ |
Set component usage with signature |
Check service provider signature
1 2 3 4 5 | |
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
ServiceProviderSignatureRequest - API Source:
marketplace_public_api_check_signature
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Field | Type | Required | Description |
|---|---|---|---|
customer |
string (uuid) | ✓ | Service provider customer UUID |
data |
string | ✓ | JWT-encoded data signed with the service provider's API secret code |
dry_run |
boolean | If true, validates the signature without executing the operation Constraints: default: False |
200 - No response body
Set component usage with signature
1 2 3 4 5 | |
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
ServiceProviderSignatureRequest - API Source:
marketplace_public_api_set_usage
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Field | Type | Required | Description |
|---|---|---|---|
customer |
string (uuid) | ✓ | Service provider customer UUID |
data |
string | ✓ | JWT-encoded data signed with the service provider's API secret code |
dry_run |
boolean | If true, validates the signature without executing the operation Constraints: default: False |
201 - No response body
Marketplace Remote Synchronisations
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/marketplace-remote-synchronisations/ |
List Marketplace Remote Synchronisations |
| GET | /api/marketplace-remote-synchronisations/{uuid}/ |
Retrieve |
| POST | /api/marketplace-remote-synchronisations/ |
Create |
| PUT | /api/marketplace-remote-synchronisations/{uuid}/ |
Update |
| PATCH | /api/marketplace-remote-synchronisations/{uuid}/ |
Partial Update |
| DELETE | /api/marketplace-remote-synchronisations/{uuid}/ |
Delete |
| Other Actions | ||
| POST | /api/marketplace-remote-synchronisations/{uuid}/run_synchronisation/ |
Run synchronisation |
Core CRUD
List Marketplace Remote Synchronisations
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
marketplace_remote_synchronisations_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
uuid |
string (uuid) |
url |
string (uri) |
api_url |
string (uri) |
token |
string |
remote_organization_uuid |
string (uuid) |
remote_organization_name |
string |
local_service_provider |
string (uri) |
local_service_provider_name |
string |
is_active |
boolean |
last_execution |
string (date-time) |
last_output |
string |
get_state_display |
string |
error_message |
string |
created |
string (date-time) |
modified |
string (date-time) |
remotelocalcategory_set |
array of objects |
remotelocalcategory_set.local_category |
string (uri) |
remotelocalcategory_set.remote_category |
string (uuid) |
remotelocalcategory_set.local_category_name |
string |
remotelocalcategory_set.local_category_uuid |
string (uuid) |
remotelocalcategory_set.remote_category_name |
string |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_remote_synchronisations_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
url |
string (uri) |
api_url |
string (uri) |
token |
string |
remote_organization_uuid |
string (uuid) |
remote_organization_name |
string |
local_service_provider |
string (uri) |
local_service_provider_name |
string |
is_active |
boolean |
last_execution |
string (date-time) |
last_output |
string |
get_state_display |
string |
error_message |
string |
created |
string (date-time) |
modified |
string (date-time) |
remotelocalcategory_set |
array of objects |
remotelocalcategory_set.local_category |
string (uri) |
remotelocalcategory_set.remote_category |
string (uuid) |
remotelocalcategory_set.local_category_name |
string |
remotelocalcategory_set.local_category_uuid |
string (uuid) |
remotelocalcategory_set.remote_category_name |
string |
Create
1 2 3 4 5 6 7 8 9 10 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 | |
- Model Source:
RemoteSynchronisationRequest - API Source:
marketplace_remote_synchronisations_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
| Field | Type | Required |
|---|---|---|
api_url |
string (uri) | ✓ |
token |
string | ✓ |
remote_organization_uuid |
string (uuid) | ✓ |
remote_organization_name |
string | ✓ |
local_service_provider |
string (uri) | ✓ |
is_active |
boolean | |
remotelocalcategory_set |
array of objects | ✓ |
remotelocalcategory_set.local_category |
string (uri) | ✓ |
remotelocalcategory_set.remote_category |
string (uuid) | ✓ |
remotelocalcategory_set.remote_category_name |
string |
201 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
url |
string (uri) |
api_url |
string (uri) |
token |
string |
remote_organization_uuid |
string (uuid) |
remote_organization_name |
string |
local_service_provider |
string (uri) |
local_service_provider_name |
string |
is_active |
boolean |
last_execution |
string (date-time) |
last_output |
string |
get_state_display |
string |
error_message |
string |
created |
string (date-time) |
modified |
string (date-time) |
remotelocalcategory_set |
array of objects |
remotelocalcategory_set.local_category |
string (uri) |
remotelocalcategory_set.remote_category |
string (uuid) |
remotelocalcategory_set.local_category_name |
string |
remotelocalcategory_set.local_category_uuid |
string (uuid) |
remotelocalcategory_set.remote_category_name |
string |
Update
1 2 3 4 5 6 7 8 9 10 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 | |
- Model Source:
RemoteSynchronisationRequest - API Source:
marketplace_remote_synchronisations_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
api_url |
string (uri) | ✓ |
token |
string | ✓ |
remote_organization_uuid |
string (uuid) | ✓ |
remote_organization_name |
string | ✓ |
local_service_provider |
string (uri) | ✓ |
is_active |
boolean | |
remotelocalcategory_set |
array of objects | ✓ |
remotelocalcategory_set.local_category |
string (uri) | ✓ |
remotelocalcategory_set.remote_category |
string (uuid) | ✓ |
remotelocalcategory_set.remote_category_name |
string |
200 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
url |
string (uri) |
api_url |
string (uri) |
token |
string |
remote_organization_uuid |
string (uuid) |
remote_organization_name |
string |
local_service_provider |
string (uri) |
local_service_provider_name |
string |
is_active |
boolean |
last_execution |
string (date-time) |
last_output |
string |
get_state_display |
string |
error_message |
string |
created |
string (date-time) |
modified |
string (date-time) |
remotelocalcategory_set |
array of objects |
remotelocalcategory_set.local_category |
string (uri) |
remotelocalcategory_set.remote_category |
string (uuid) |
remotelocalcategory_set.local_category_name |
string |
remotelocalcategory_set.local_category_uuid |
string (uuid) |
remotelocalcategory_set.remote_category_name |
string |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedRemoteSynchronisationRequest - API Source:
marketplace_remote_synchronisations_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
api_url |
string (uri) | |
token |
string | |
remote_organization_name |
string | |
local_service_provider |
string (uri) | |
is_active |
boolean | |
remotelocalcategory_set |
array of objects | |
remotelocalcategory_set.local_category |
string (uri) | ✓ |
remotelocalcategory_set.remote_category |
string (uuid) | ✓ |
remotelocalcategory_set.remote_category_name |
string |
200 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
url |
string (uri) |
api_url |
string (uri) |
token |
string |
remote_organization_uuid |
string (uuid) |
remote_organization_name |
string |
local_service_provider |
string (uri) |
local_service_provider_name |
string |
is_active |
boolean |
last_execution |
string (date-time) |
last_output |
string |
get_state_display |
string |
error_message |
string |
created |
string (date-time) |
modified |
string (date-time) |
remotelocalcategory_set |
array of objects |
remotelocalcategory_set.local_category |
string (uri) |
remotelocalcategory_set.remote_category |
string (uuid) |
remotelocalcategory_set.local_category_name |
string |
remotelocalcategory_set.local_category_uuid |
string (uuid) |
remotelocalcategory_set.remote_category_name |
string |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_remote_synchronisations_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
Run synchronisation
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
url |
string (uri) |
api_url |
string (uri) |
token |
string |
remote_organization_uuid |
string (uuid) |
remote_organization_name |
string |
local_service_provider |
string (uri) |
local_service_provider_name |
string |
is_active |
boolean |
last_execution |
string (date-time) |
last_output |
string |
get_state_display |
string |
error_message |
string |
created |
string (date-time) |
modified |
string (date-time) |
remotelocalcategory_set |
array of objects |
remotelocalcategory_set.local_category |
string (uri) |
remotelocalcategory_set.remote_category |
string (uuid) |
remotelocalcategory_set.local_category_name |
string |
remotelocalcategory_set.local_category_uuid |
string (uuid) |
remotelocalcategory_set.remote_category_name |
string |
Remote Waldur Api
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| POST | /api/remote-waldur-api/pull_offering_details/{uuid}/ |
Details |
| POST | /api/remote-waldur-api/pull_offering_invoices/{uuid}/ |
Invoices |
| POST | /api/remote-waldur-api/pull_offering_orders/{uuid}/ |
Orders |
| POST | /api/remote-waldur-api/pull_offering_resources/{uuid}/ |
Resources |
| POST | /api/remote-waldur-api/pull_offering_robot_accounts/{uuid}/ |
Accounts |
| POST | /api/remote-waldur-api/pull_offering_usage/{uuid}/ |
Usage |
| POST | /api/remote-waldur-api/pull_offering_users/{uuid}/ |
Users |
| POST | /api/remote-waldur-api/pull_order/{uuid} |
Schedule order pull task |
| POST | /api/remote-waldur-api/pull_resource_robot_accounts/{uuid}/ |
Accounts |
| Other Actions | ||
| GET | /api/remote-waldur-api/remote_resource_order_status/{resource_uuid}/ |
Get remote order details |
| GET | /api/remote-waldur-api/remote_resource_status/{resource_uuid}/ |
Get remote resource sync status |
| GET | /api/remote-waldur-api/remote_resource_team_status/{resource_uuid}/ |
Get remote resource team members |
| POST | /api/remote-waldur-api/cancel_termination/{uuid} |
Cancel termination order |
| POST | /api/remote-waldur-api/import_offering/ |
Create local offering from remote |
| POST | /api/remote-waldur-api/push_project_data/{uuid}/ |
Data |
| POST | /api/remote-waldur-api/remote_categories/ |
List remote marketplace categories |
| POST | /api/remote-waldur-api/remote_customers/ |
List remote customers owned by current user |
| POST | /api/remote-waldur-api/shared_offerings/ |
List remote importable offerings for particular customer |
| POST | /api/remote-waldur-api/sync_resource/{uuid}/ |
Resource |
| POST | /api/remote-waldur-api/sync_resource_project_permissions/{uuid}/ |
Permissions |
Core CRUD
Details
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
remote_waldur_api_pull_offering_details
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string | ✓ |
200 - No response body
Invoices
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
remote_waldur_api_pull_offering_invoices
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string | ✓ |
200 - No response body
Orders
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
remote_waldur_api_pull_offering_orders
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string | ✓ |
200 - No response body
Resources
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
remote_waldur_api_pull_offering_resources
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string | ✓ |
200 - No response body
Accounts
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
remote_waldur_api_pull_offering_robot_accounts
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string | ✓ |
200 - No response body
Usage
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
remote_waldur_api_pull_offering_usage
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string | ✓ |
200 - No response body
Users
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
remote_waldur_api_pull_offering_users
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string | ✓ |
200 - No response body
Schedule order pull task
Schedule order pull task
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
remote_waldur_api_pull_order
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string | ✓ |
200 - No response body
Accounts
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
remote_waldur_api_pull_resource_robot_accounts
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string | ✓ |
200 - No response body
Other Actions
Get remote order details
Get remote order details
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
resource_uuid |
string | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
order_uuid |
string (uuid) | Order UUID |
remote_state |
any | Remote order state |
local_state |
any | Local order state |
sync_status |
any | Sync status: in_sync, out_of_sync, sync_failed |
Get remote resource sync status
Get remote resource sync status
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
resource_uuid |
string | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
local_state |
any | Local resource state |
remote_state |
any | Remote resource state |
sync_status |
any | Sync status: in_sync, out_of_sync, sync_failed |
last_sync |
string (date-time) | Last sync timestamp |
Get remote resource team members
Get remote resource team members
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
resource_uuid |
string | ✓ |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
full_name |
string | Full name |
local_role |
string | Local role |
remote_role |
string | Remote role |
sync_status |
any | Sync status: in_sync, out_of_sync, sync_failed |
Cancel termination order
Cancel termination order
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
remote_waldur_api_cancel_termination
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string | ✓ |
200 - No response body
Create local offering from remote
Create local offering from remote
1 2 3 4 5 6 7 8 9 10 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 | |
- Model Source:
RemoteOfferingCreateRequest - API Source:
remote_waldur_api_import_offering
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
| Field | Type | Required |
|---|---|---|
api_url |
string (uri) | ✓ |
token |
string | ✓ |
remote_offering_uuid |
string (uuid) | ✓ |
local_category_uuid |
string (uuid) | ✓ |
local_customer_uuid |
string (uuid) | ✓ |
remote_customer_uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
Data
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
remote_waldur_api_push_project_data
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string | ✓ |
200 - No response body
List remote marketplace categories
List remote marketplace categories
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
RemoteCredentialsRequest - API Source:
remote_waldur_api_remote_categories
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
| Field | Type | Required |
|---|---|---|
api_url |
string (uri) | ✓ |
token |
string | ✓ |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
title |
string | |
description |
string | |
icon |
string (uri) | |
default_vm_category |
boolean | Set to "true" if this category is for OpenStack VM. Only one category can have "true" value. |
default_volume_category |
boolean | Set to true if this category is for OpenStack Volume. Only one category can have "true" value. |
default_tenant_category |
boolean | Set to true if this category is for OpenStack Tenant. Only one category can have "true" value. |
offering_count |
integer | |
available_offerings_count |
integer | |
sections |
array of objects | |
sections.key |
string | |
sections.title |
string | |
sections.attributes |
array of objects | |
sections.attributes.key |
string | |
sections.attributes.title |
string | |
sections.attributes.type |
string | Enum: boolean, string, text, integer, choice, list |
sections.attributes.options |
array of objects | |
sections.attributes.options.key |
string | |
sections.attributes.options.title |
string | |
sections.attributes.required |
boolean | A value must be provided for the attribute. |
sections.attributes.default |
any | |
sections.is_standalone |
boolean | Whether section is rendered as a separate tab. |
columns |
array of objects | |
columns.uuid |
string (uuid) | |
columns.index |
integer | Index allows to reorder columns. |
columns.title |
string | Title is rendered as column header. |
columns.attribute |
string | Resource attribute is rendered as table cell. |
columns.widget |
any | Widget field allows to customise table cell rendering. |
components |
array of objects | |
components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
components.name |
string | Display name for the measured unit, for example, Floating IP. |
components.description |
string | |
components.measured_unit |
string | Unit of measurement, for example, GB. |
articles |
array of objects | |
articles.title |
string | |
articles.url |
string (uri) | |
group |
string (uri) |
List remote customers owned by current user
List remote customers owned by current user
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
RemoteCredentialsRequest - API Source:
remote_waldur_api_remote_customers
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
| Field | Type | Required |
|---|---|---|
api_url |
string (uri) | ✓ |
token |
string | ✓ |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
uuid |
string (uuid) |
name |
string |
abbreviation |
string |
phone_number |
string |
email |
string |
List remote importable offerings for particular customer
List remote importable offerings for particular customer
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
RemoteCredentialsRequest - API Source:
remote_waldur_api_shared_offerings
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Name | Type | Description |
|---|---|---|
customer_uuid |
string | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
| Field | Type | Required |
|---|---|---|
api_url |
string (uri) | ✓ |
token |
string | ✓ |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
uuid |
string (uuid) |
name |
string |
type |
string |
state |
string |
category_title |
string |
Resource
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
remote_waldur_api_sync_resource
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string | ✓ |
200 - No response body
Permissions
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string | ✓ |
200 - No response body
Maintenance
Maintenance Announcement Offerings
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/maintenance-announcement-offerings/ |
List affected offerings for maintenance |
| GET | /api/maintenance-announcement-offerings/{uuid}/ |
Retrieve an affected offering link |
| POST | /api/maintenance-announcement-offerings/ |
Link an offering to a maintenance announcement |
| PUT | /api/maintenance-announcement-offerings/{uuid}/ |
Update an affected offering link |
| PATCH | /api/maintenance-announcement-offerings/{uuid}/ |
Partially update an affected offering link |
| DELETE | /api/maintenance-announcement-offerings/{uuid}/ |
Unlink an offering from a maintenance announcement |
List affected offerings for maintenance
Returns a paginated list of offerings affected by maintenance announcements.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
maintenance_announcement_offerings_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
maintenance |
string (uri) | |
offering |
string (uri) | |
impact_level |
any | Expected impact on this offering |
impact_level_display |
any | |
impact_description |
string | Specific description of how this offering will be affected |
offering_name |
string |
Retrieve an affected offering link
Returns the details of a specific link between a maintenance announcement and an offering, including the impact level and description.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
maintenance_announcement_offerings_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
maintenance |
string (uri) | |
offering |
string (uri) | |
impact_level |
any | Expected impact on this offering |
impact_level_display |
any | |
impact_description |
string | Specific description of how this offering will be affected |
offering_name |
string |
Link an offering to a maintenance announcement
Creates a new association between an offering and a maintenance announcement, specifying the expected impact.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
MaintenanceAnnouncementOfferingRequest - API Source:
maintenance_announcement_offerings_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Field | Type | Required | Description |
|---|---|---|---|
maintenance |
string (uri) | ✓ | |
offering |
string (uri) | ✓ | |
impact_level |
any | Expected impact on this offering | |
impact_description |
string | Specific description of how this offering will be affected |
201 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
maintenance |
string (uri) | |
offering |
string (uri) | |
impact_level |
any | Expected impact on this offering |
impact_level_display |
any | |
impact_description |
string | Specific description of how this offering will be affected |
offering_name |
string |
Update an affected offering link
Updates the impact level or description for an offering linked to a maintenance announcement.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
MaintenanceAnnouncementOfferingRequest - API Source:
maintenance_announcement_offerings_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
maintenance |
string (uri) | ✓ | |
offering |
string (uri) | ✓ | |
impact_level |
any | Expected impact on this offering | |
impact_description |
string | Specific description of how this offering will be affected |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
maintenance |
string (uri) | |
offering |
string (uri) | |
impact_level |
any | Expected impact on this offering |
impact_level_display |
any | |
impact_description |
string | Specific description of how this offering will be affected |
offering_name |
string |
Partially update an affected offering link
Partially updates the impact level or description for an offering linked to a maintenance announcement.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedMaintenanceAnnouncementOfferingRequest - API Source:
maintenance_announcement_offerings_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
maintenance |
string (uri) | ||
offering |
string (uri) | ||
impact_level |
any | Expected impact on this offering | |
impact_description |
string | Specific description of how this offering will be affected |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
maintenance |
string (uri) | |
offering |
string (uri) | |
impact_level |
any | Expected impact on this offering |
impact_level_display |
any | |
impact_description |
string | Specific description of how this offering will be affected |
offering_name |
string |
Unlink an offering from a maintenance announcement
Removes the association between an offering and a maintenance announcement.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
maintenance_announcement_offerings_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Maintenance Announcement Template Offerings
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/maintenance-announcement-template-offerings/ |
List affected offering templates |
| GET | /api/maintenance-announcement-template-offerings/{uuid}/ |
Retrieve an affected offering template link |
| POST | /api/maintenance-announcement-template-offerings/ |
Link an offering to a maintenance template |
| PUT | /api/maintenance-announcement-template-offerings/{uuid}/ |
Update an affected offering template link |
| PATCH | /api/maintenance-announcement-template-offerings/{uuid}/ |
Partially update an affected offering template link |
| DELETE | /api/maintenance-announcement-template-offerings/{uuid}/ |
Unlink an offering from a maintenance template |
List affected offering templates
Returns a paginated list of associations between maintenance announcement templates and offerings.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 | |
- Model Source:
BackendResourceReqOEnum - API Source:
maintenance_announcement_template_offerings_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
impact_level |
integer | Impact level |
maintenance_template_uuid |
string (uuid) | Maintenance template UUID |
o |
array | Ordering |
offering_uuid |
string (uuid) | Offering UUID |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
service_provider_uuid |
string (uuid) | Service provider UUID |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
maintenance_template |
string (uri) | |
offering |
string (uri) | |
offering_name |
string | |
offering_uuid |
string (uuid) | |
impact_level |
any | Expected impact on this offering |
impact_description |
string | Specific description of how this offering will be affected |
Retrieve an affected offering template link
Returns the details of a specific link between a maintenance announcement template and an offering.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
maintenance_template |
string (uri) | |
offering |
string (uri) | |
offering_name |
string | |
offering_uuid |
string (uuid) | |
impact_level |
any | Expected impact on this offering |
impact_description |
string | Specific description of how this offering will be affected |
Link an offering to a maintenance template
Creates a reusable association between an offering and a maintenance announcement template, specifying a default impact level and description.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
MaintenanceAnnouncementOfferingTemplateRequest - API Source:
maintenance_announcement_template_offerings_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Field | Type | Required | Description |
|---|---|---|---|
maintenance_template |
string (uri) | ✓ | |
offering |
string (uri) | ✓ | |
impact_level |
any | Expected impact on this offering | |
impact_description |
string | Specific description of how this offering will be affected |
201 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
maintenance_template |
string (uri) | |
offering |
string (uri) | |
offering_name |
string | |
offering_uuid |
string (uuid) | |
impact_level |
any | Expected impact on this offering |
impact_description |
string | Specific description of how this offering will be affected |
Update an affected offering template link
Updates the default impact level or description for an offering linked to a maintenance template.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
MaintenanceAnnouncementOfferingTemplateRequest - API Source:
maintenance_announcement_template_offerings_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
maintenance_template |
string (uri) | ✓ | |
offering |
string (uri) | ✓ | |
impact_level |
any | Expected impact on this offering | |
impact_description |
string | Specific description of how this offering will be affected |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
maintenance_template |
string (uri) | |
offering |
string (uri) | |
offering_name |
string | |
offering_uuid |
string (uuid) | |
impact_level |
any | Expected impact on this offering |
impact_description |
string | Specific description of how this offering will be affected |
Partially update an affected offering template link
Partially updates the default impact level or description for an offering linked to a maintenance template.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
maintenance_template |
string (uri) | ||
offering |
string (uri) | ||
impact_level |
any | Expected impact on this offering | |
impact_description |
string | Specific description of how this offering will be affected |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
maintenance_template |
string (uri) | |
offering |
string (uri) | |
offering_name |
string | |
offering_uuid |
string (uuid) | |
impact_level |
any | Expected impact on this offering |
impact_description |
string | Specific description of how this offering will be affected |
Unlink an offering from a maintenance template
Removes the association between an offering and a maintenance announcement template.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Maintenance Announcements Template
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/maintenance-announcements-template/ |
List maintenance announcement templates |
| GET | /api/maintenance-announcements-template/{uuid}/ |
Retrieve a maintenance announcement template |
| POST | /api/maintenance-announcements-template/ |
Create a maintenance announcement template |
| PUT | /api/maintenance-announcements-template/{uuid}/ |
Update a maintenance announcement template |
| PATCH | /api/maintenance-announcements-template/{uuid}/ |
Partially update a maintenance announcement template |
| DELETE | /api/maintenance-announcements-template/{uuid}/ |
Delete a maintenance announcement template |
List maintenance announcement templates
Returns a paginated list of reusable templates for maintenance announcements.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 | |
- Model Source:
MaintenanceAnnouncementTemplateOEnum - API Source:
maintenance_announcements_template_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
maintenance_type |
integer | Maintenance type |
o |
array | Ordering |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
service_provider_uuid |
string (uuid) | Service provider UUID |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
message |
string | |
maintenance_type |
any | Type of maintenance being performed |
service_provider |
string (uri) | Service provider announcing the maintenance |
affected_offerings |
array of objects | |
affected_offerings.url |
string (uri) | |
affected_offerings.uuid |
string (uuid) | |
affected_offerings.maintenance |
string (uri) | |
affected_offerings.offering |
string (uri) | |
affected_offerings.impact_level |
any | Expected impact on this offering |
affected_offerings.impact_level_display |
any | |
affected_offerings.impact_description |
string | Specific description of how this offering will be affected |
affected_offerings.offering_name |
string |
Retrieve a maintenance announcement template
Returns the details of a specific maintenance announcement template.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
maintenance_announcements_template_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
message |
string | |
maintenance_type |
any | Type of maintenance being performed |
service_provider |
string (uri) | Service provider announcing the maintenance |
affected_offerings |
array of objects | |
affected_offerings.url |
string (uri) | |
affected_offerings.uuid |
string (uuid) | |
affected_offerings.maintenance |
string (uri) | |
affected_offerings.offering |
string (uri) | |
affected_offerings.impact_level |
any | Expected impact on this offering |
affected_offerings.impact_level_display |
any | |
affected_offerings.impact_description |
string | Specific description of how this offering will be affected |
affected_offerings.offering_name |
string |
Create a maintenance announcement template
Creates a new reusable template for maintenance announcements, including a default message and type.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
MaintenanceAnnouncementTemplateRequest - API Source:
maintenance_announcements_template_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ✓ | |
message |
string | ||
maintenance_type |
any | Type of maintenance being performed | |
service_provider |
string (uri) | ✓ | Service provider announcing the maintenance |
201 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
message |
string | |
maintenance_type |
any | Type of maintenance being performed |
service_provider |
string (uri) | Service provider announcing the maintenance |
affected_offerings |
array of objects | |
affected_offerings.url |
string (uri) | |
affected_offerings.uuid |
string (uuid) | |
affected_offerings.maintenance |
string (uri) | |
affected_offerings.offering |
string (uri) | |
affected_offerings.impact_level |
any | Expected impact on this offering |
affected_offerings.impact_level_display |
any | |
affected_offerings.impact_description |
string | Specific description of how this offering will be affected |
affected_offerings.offering_name |
string |
Update a maintenance announcement template
Updates an existing maintenance announcement template.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
MaintenanceAnnouncementTemplateRequest - API Source:
maintenance_announcements_template_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ✓ | |
message |
string | ||
maintenance_type |
any | Type of maintenance being performed | |
service_provider |
string (uri) | ✓ | Service provider announcing the maintenance |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
message |
string | |
maintenance_type |
any | Type of maintenance being performed |
service_provider |
string (uri) | Service provider announcing the maintenance |
affected_offerings |
array of objects | |
affected_offerings.url |
string (uri) | |
affected_offerings.uuid |
string (uuid) | |
affected_offerings.maintenance |
string (uri) | |
affected_offerings.offering |
string (uri) | |
affected_offerings.impact_level |
any | Expected impact on this offering |
affected_offerings.impact_level_display |
any | |
affected_offerings.impact_description |
string | Specific description of how this offering will be affected |
affected_offerings.offering_name |
string |
Partially update a maintenance announcement template
Partially updates an existing maintenance announcement template.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedMaintenanceAnnouncementTemplateRequest - API Source:
maintenance_announcements_template_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ||
message |
string | ||
maintenance_type |
any | Type of maintenance being performed | |
service_provider |
string (uri) | Service provider announcing the maintenance |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
message |
string | |
maintenance_type |
any | Type of maintenance being performed |
service_provider |
string (uri) | Service provider announcing the maintenance |
affected_offerings |
array of objects | |
affected_offerings.url |
string (uri) | |
affected_offerings.uuid |
string (uuid) | |
affected_offerings.maintenance |
string (uri) | |
affected_offerings.offering |
string (uri) | |
affected_offerings.impact_level |
any | Expected impact on this offering |
affected_offerings.impact_level_display |
any | |
affected_offerings.impact_description |
string | Specific description of how this offering will be affected |
affected_offerings.offering_name |
string |
Delete a maintenance announcement template
Deletes a maintenance announcement template.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
maintenance_announcements_template_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Maintenance Announcements
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/maintenance-announcements/ |
List maintenance announcements |
| GET | /api/maintenance-announcements/{uuid}/ |
Retrieve a maintenance announcement |
| POST | /api/maintenance-announcements/ |
Create a maintenance announcement |
| PUT | /api/maintenance-announcements/{uuid}/ |
Update a maintenance announcement |
| PATCH | /api/maintenance-announcements/{uuid}/ |
Partially update a maintenance announcement |
| DELETE | /api/maintenance-announcements/{uuid}/ |
Delete a maintenance announcement |
| Other Actions | ||
| GET | /api/maintenance-announcements/maintenance_stats/ |
Get maintenance announcement statistics |
| POST | /api/maintenance-announcements/{uuid}/cancel_maintenance/ |
Cancel the maintenance announcement |
| POST | /api/maintenance-announcements/{uuid}/complete_maintenance/ |
Complete the maintenance announcement |
| POST | /api/maintenance-announcements/{uuid}/schedule/ |
Schedule/publish the maintenance announcement |
| POST | /api/maintenance-announcements/{uuid}/start_maintenance/ |
Start the maintenance announcement |
| POST | /api/maintenance-announcements/{uuid}/unschedule/ |
Unschedule/unpublish the maintenance announcement |
Core CRUD
List maintenance announcements
Returns a paginated list of maintenance announcements.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- Model Source:
MaintenanceAnnouncementOEnum - Model Source:
MaintenanceAnnouncementStateEnum - API Source:
maintenance_announcements_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
maintenance_type |
integer | Maintenance type |
o |
array | Ordering |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
scheduled_end_after |
string (date-time) | Scheduled end after |
scheduled_end_before |
string (date-time) | Scheduled end before |
scheduled_start_after |
string (date-time) | Scheduled start after |
scheduled_start_before |
string (date-time) | Scheduled start before |
service_provider_uuid |
string (uuid) | Service provider UUID |
state |
array | Maintenance state |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
message |
string | |
internal_notes |
string | |
maintenance_type |
any | Type of maintenance being performed |
external_reference_url |
string (uri) | Optional reference to an external maintenance tracker |
state |
any | |
scheduled_start |
string (date-time) | When the maintenance is scheduled to begin |
scheduled_end |
string (date-time) | When the maintenance is scheduled to complete |
actual_start |
string (date-time) | When the maintenance actually began |
actual_end |
string (date-time) | When the maintenance actually completed |
service_provider |
string (uri) | Service provider announcing the maintenance |
created_by |
string (uri) | |
affected_offerings |
array of objects | |
affected_offerings.url |
string (uri) | |
affected_offerings.uuid |
string (uuid) | |
affected_offerings.maintenance |
string (uri) | |
affected_offerings.offering |
string (uri) | |
affected_offerings.impact_level |
any | Expected impact on this offering |
affected_offerings.impact_level_display |
any | |
affected_offerings.impact_description |
string | Specific description of how this offering will be affected |
affected_offerings.offering_name |
string | |
service_provider_name |
string | |
backend_id |
string |
Retrieve a maintenance announcement
Returns the details of a specific maintenance announcement.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
maintenance_announcements_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
message |
string | |
internal_notes |
string | |
maintenance_type |
any | Type of maintenance being performed |
external_reference_url |
string (uri) | Optional reference to an external maintenance tracker |
state |
any | |
scheduled_start |
string (date-time) | When the maintenance is scheduled to begin |
scheduled_end |
string (date-time) | When the maintenance is scheduled to complete |
actual_start |
string (date-time) | When the maintenance actually began |
actual_end |
string (date-time) | When the maintenance actually completed |
service_provider |
string (uri) | Service provider announcing the maintenance |
created_by |
string (uri) | |
affected_offerings |
array of objects | |
affected_offerings.url |
string (uri) | |
affected_offerings.uuid |
string (uuid) | |
affected_offerings.maintenance |
string (uri) | |
affected_offerings.offering |
string (uri) | |
affected_offerings.impact_level |
any | Expected impact on this offering |
affected_offerings.impact_level_display |
any | |
affected_offerings.impact_description |
string | Specific description of how this offering will be affected |
affected_offerings.offering_name |
string | |
service_provider_name |
string | |
backend_id |
string |
Create a maintenance announcement
Creates a new maintenance announcement in the 'Draft' state.
1 2 3 4 5 6 7 8 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | |
- Model Source:
MaintenanceAnnouncementRequest - API Source:
maintenance_announcements_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ✓ | |
message |
string | ||
internal_notes |
string | ||
maintenance_type |
any | Type of maintenance being performed | |
external_reference_url |
string (uri) | Optional reference to an external maintenance tracker | |
scheduled_start |
string (date-time) | ✓ | When the maintenance is scheduled to begin |
scheduled_end |
string (date-time) | ✓ | When the maintenance is scheduled to complete |
service_provider |
string (uri) | ✓ | Service provider announcing the maintenance |
201 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
message |
string | |
internal_notes |
string | |
maintenance_type |
any | Type of maintenance being performed |
external_reference_url |
string (uri) | Optional reference to an external maintenance tracker |
state |
any | |
scheduled_start |
string (date-time) | When the maintenance is scheduled to begin |
scheduled_end |
string (date-time) | When the maintenance is scheduled to complete |
actual_start |
string (date-time) | When the maintenance actually began |
actual_end |
string (date-time) | When the maintenance actually completed |
service_provider |
string (uri) | Service provider announcing the maintenance |
created_by |
string (uri) | |
affected_offerings |
array of objects | |
affected_offerings.url |
string (uri) | |
affected_offerings.uuid |
string (uuid) | |
affected_offerings.maintenance |
string (uri) | |
affected_offerings.offering |
string (uri) | |
affected_offerings.impact_level |
any | Expected impact on this offering |
affected_offerings.impact_level_display |
any | |
affected_offerings.impact_description |
string | Specific description of how this offering will be affected |
affected_offerings.offering_name |
string | |
service_provider_name |
string | |
backend_id |
string |
Update a maintenance announcement
Updates an existing maintenance announcement.
1 2 3 4 5 6 7 8 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 | |
- Model Source:
MaintenanceAnnouncementRequest - API Source:
maintenance_announcements_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ✓ | |
message |
string | ||
internal_notes |
string | ||
maintenance_type |
any | Type of maintenance being performed | |
external_reference_url |
string (uri) | Optional reference to an external maintenance tracker | |
scheduled_start |
string (date-time) | ✓ | When the maintenance is scheduled to begin |
scheduled_end |
string (date-time) | ✓ | When the maintenance is scheduled to complete |
service_provider |
string (uri) | ✓ | Service provider announcing the maintenance |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
message |
string | |
internal_notes |
string | |
maintenance_type |
any | Type of maintenance being performed |
external_reference_url |
string (uri) | Optional reference to an external maintenance tracker |
state |
any | |
scheduled_start |
string (date-time) | When the maintenance is scheduled to begin |
scheduled_end |
string (date-time) | When the maintenance is scheduled to complete |
actual_start |
string (date-time) | When the maintenance actually began |
actual_end |
string (date-time) | When the maintenance actually completed |
service_provider |
string (uri) | Service provider announcing the maintenance |
created_by |
string (uri) | |
affected_offerings |
array of objects | |
affected_offerings.url |
string (uri) | |
affected_offerings.uuid |
string (uuid) | |
affected_offerings.maintenance |
string (uri) | |
affected_offerings.offering |
string (uri) | |
affected_offerings.impact_level |
any | Expected impact on this offering |
affected_offerings.impact_level_display |
any | |
affected_offerings.impact_description |
string | Specific description of how this offering will be affected |
affected_offerings.offering_name |
string | |
service_provider_name |
string | |
backend_id |
string |
Partially update a maintenance announcement
Partially updates an existing maintenance announcement.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedMaintenanceAnnouncementRequest - API Source:
maintenance_announcements_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ||
message |
string | ||
internal_notes |
string | ||
maintenance_type |
any | Type of maintenance being performed | |
external_reference_url |
string (uri) | Optional reference to an external maintenance tracker | |
scheduled_start |
string (date-time) | When the maintenance is scheduled to begin | |
scheduled_end |
string (date-time) | When the maintenance is scheduled to complete | |
service_provider |
string (uri) | Service provider announcing the maintenance |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
message |
string | |
internal_notes |
string | |
maintenance_type |
any | Type of maintenance being performed |
external_reference_url |
string (uri) | Optional reference to an external maintenance tracker |
state |
any | |
scheduled_start |
string (date-time) | When the maintenance is scheduled to begin |
scheduled_end |
string (date-time) | When the maintenance is scheduled to complete |
actual_start |
string (date-time) | When the maintenance actually began |
actual_end |
string (date-time) | When the maintenance actually completed |
service_provider |
string (uri) | Service provider announcing the maintenance |
created_by |
string (uri) | |
affected_offerings |
array of objects | |
affected_offerings.url |
string (uri) | |
affected_offerings.uuid |
string (uuid) | |
affected_offerings.maintenance |
string (uri) | |
affected_offerings.offering |
string (uri) | |
affected_offerings.impact_level |
any | Expected impact on this offering |
affected_offerings.impact_level_display |
any | |
affected_offerings.impact_description |
string | Specific description of how this offering will be affected |
affected_offerings.offering_name |
string | |
service_provider_name |
string | |
backend_id |
string |
Delete a maintenance announcement
Deletes a maintenance announcement.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
maintenance_announcements_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
Get maintenance announcement statistics
Returns comprehensive statistics for maintenance announcements including counts by state, type, impact level, and daily breakdown.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
end |
string | End date in YYYY-MM-DD format. Defaults to 30 days in the future. |
provider_uuid |
string | Filter by service provider UUID. |
start |
string | Start date in YYYY-MM-DD format. Defaults to 90 days ago. |
200 -
| Field | Type | Description |
|---|---|---|
summary |
any | Summary statistics |
by_state |
object (free-form) | Total counts grouped by state |
by_type |
object (free-form) | Total counts grouped by maintenance type |
by_impact_level |
object (free-form) | Total counts grouped by max impact level |
daily |
array of objects | Daily breakdown |
daily.date |
string (date) | Date |
daily.count |
integer | Number of maintenances on this day |
daily.by_state |
object (free-form) | Maintenance counts grouped by state |
providers |
array of objects | Statistics per provider |
providers.uuid |
string | Service provider UUID |
providers.name |
string | Service provider name |
providers.total |
integer | Total maintenances |
providers.active |
integer | Active maintenances |
providers.scheduled |
integer | Scheduled maintenances |
providers.completed |
integer | Completed maintenances |
Cancel the maintenance announcement
Transitions a 'Draft' or 'Scheduled' maintenance announcement to 'Cancelled'.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
maintenance_announcements_cancel_maintenance
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
detail |
string | Response message describing the action result |
Complete the maintenance announcement
Transitions an 'In progress' maintenance announcement to 'Completed', indicating that the maintenance work has finished.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
maintenance_announcements_complete_maintenance
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
detail |
string | Response message describing the action result |
Schedule/publish the maintenance announcement
Transitions a 'Draft' maintenance announcement to the 'Scheduled' state, making it publicly visible.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
maintenance_announcements_schedule
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
detail |
string | Response message describing the action result |
Start the maintenance announcement
Transitions a 'Scheduled' maintenance announcement to 'In progress', indicating that the maintenance work has begun.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
maintenance_announcements_start_maintenance
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
detail |
string | Response message describing the action result |
Unschedule/unpublish the maintenance announcement
Transitions a 'Scheduled' maintenance announcement back to the 'Draft' state, hiding it from public view.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
maintenance_announcements_unschedule
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
detail |
string | Response message describing the action result |
Public Maintenance Announcements
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/public-maintenance-announcements/ |
List public maintenance announcements |
| GET | /api/public-maintenance-announcements/{uuid}/ |
Retrieve a public maintenance announcement |
List public maintenance announcements
Returns a paginated list of public maintenance announcements. Only announcements that are 'Scheduled', 'In progress', or 'Completed' are visible. This endpoint is accessible to unauthenticated users.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- Model Source:
MaintenanceAnnouncementOEnum - Model Source:
MaintenanceAnnouncementStateEnum - API Source:
public_maintenance_announcements_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
maintenance_type |
integer | Maintenance type |
o |
array | Ordering |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
scheduled_end_after |
string (date-time) | Scheduled end after |
scheduled_end_before |
string (date-time) | Scheduled end before |
scheduled_start_after |
string (date-time) | Scheduled start after |
scheduled_start_before |
string (date-time) | Scheduled start before |
service_provider_uuid |
string (uuid) | Service provider UUID |
state |
array | Maintenance state |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
message |
string | |
maintenance_type |
any | Type of maintenance being performed |
maintenance_type_display |
string | |
external_reference_url |
string (uri) | Optional reference to an external maintenance tracker |
state |
any | |
scheduled_start |
string (date-time) | When the maintenance is scheduled to begin |
scheduled_end |
string (date-time) | When the maintenance is scheduled to complete |
actual_start |
string (date-time) | When the maintenance actually began |
actual_end |
string (date-time) | When the maintenance actually completed |
affected_offerings |
array of objects | |
affected_offerings.url |
string (uri) | |
affected_offerings.uuid |
string (uuid) | |
affected_offerings.maintenance |
string (uri) | |
affected_offerings.offering |
string (uri) | |
affected_offerings.impact_level |
any | Expected impact on this offering |
affected_offerings.impact_level_display |
any | |
affected_offerings.impact_description |
string | Specific description of how this offering will be affected |
affected_offerings.offering_name |
string | |
service_provider_name |
string |
Retrieve a public maintenance announcement
Returns the details of a specific public maintenance announcement.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
public_maintenance_announcements_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
message |
string | |
maintenance_type |
any | Type of maintenance being performed |
maintenance_type_display |
string | |
external_reference_url |
string (uri) | Optional reference to an external maintenance tracker |
state |
any | |
scheduled_start |
string (date-time) | When the maintenance is scheduled to begin |
scheduled_end |
string (date-time) | When the maintenance is scheduled to complete |
actual_start |
string (date-time) | When the maintenance actually began |
actual_end |
string (date-time) | When the maintenance actually completed |
affected_offerings |
array of objects | |
affected_offerings.url |
string (uri) | |
affected_offerings.uuid |
string (uuid) | |
affected_offerings.maintenance |
string (uri) | |
affected_offerings.offering |
string (uri) | |
affected_offerings.impact_level |
any | Expected impact on this offering |
affected_offerings.impact_level_display |
any | |
affected_offerings.impact_description |
string | Specific description of how this offering will be affected |
affected_offerings.offering_name |
string | |
service_provider_name |
string |
Offerings
Marketplace Demo Presets
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/marketplace-demo-presets/list/ |
List demo presets |
| Other Actions | ||
| GET | /api/marketplace-demo-presets/info/{name}/ |
Get demo preset details |
| POST | /api/marketplace-demo-presets/load/{name}/ |
Load demo preset |
Core CRUD
List demo presets
Returns a list of available demo data presets. Staff access only.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
marketplace_demo_presets_list_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
name |
string |
title |
string |
description |
string |
version |
string |
entity_counts |
object (free-form) |
scenarios |
array of strings |
Other Actions
Get demo preset details
Returns detailed information about a specific demo preset. Staff access only.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_demo_presets_info_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required | Description |
|---|---|---|---|
name |
string | ✓ | Name of the preset |
200 -
| Field | Type |
|---|---|
name |
string |
title |
string |
description |
string |
version |
string |
entity_counts |
object (free-form) |
scenarios |
array of strings |
404 - No response body
Load demo preset
Load a demo preset into the database. This operation will optionally clean up existing data before loading. Staff access only.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
DemoPresetLoadRequestRequest - API Source:
marketplace_demo_presets_load
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required | Description |
|---|---|---|---|
name |
string | ✓ | Name of the preset to load |
| Field | Type | Required | Description |
|---|---|---|---|
dry_run |
boolean | Preview changes without applying them Constraints: default: False |
|
cleanup_first |
boolean | Clean up existing data before loading the preset Constraints: default: True |
|
skip_users |
boolean | Skip user import/cleanup Constraints: default: False |
|
skip_roles |
boolean | Skip role import/cleanup Constraints: default: False |
200 -
| Field | Type |
|---|---|
success |
boolean |
message |
string |
output |
string |
users |
array of objects |
users.username |
string |
users.password |
string |
users.email |
string |
users.is_staff |
boolean |
users.is_support |
boolean |
400 - No response body
404 - No response body
Marketplace Offering Files
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/marketplace-offering-files/ |
List Marketplace Offering Files |
| GET | /api/marketplace-offering-files/{uuid}/ |
Retrieve |
| POST | /api/marketplace-offering-files/ |
Create |
| DELETE | /api/marketplace-offering-files/{uuid}/ |
Delete |
List Marketplace Offering Files
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- Model Source:
MaintenanceAnnouncementTemplateOEnum - Model Source:
OfferingFileFieldEnum - API Source:
marketplace_offering_files_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
field |
array | |
o |
array | Ordering |
offering |
string (uri) | |
offering_slug |
array | Multiple values may be separated by commas. |
offering_uuid |
array | Multiple values may be separated by commas. |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
parent_offering_uuid |
string (uuid) |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
offering |
string (uri) |
created |
string (date-time) |
file |
string (uri) |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
OfferingFileFieldEnum - API Source:
marketplace_offering_files_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
offering |
string (uri) |
created |
string (date-time) |
file |
string (uri) |
Create
1 2 3 4 5 6 7 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
OfferingFileRequest - API Source:
marketplace_offering_files_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
| Field | Type | Required |
|---|---|---|
name |
string | ✓ |
offering |
string (uri) | ✓ |
file |
string (binary) | ✓ |
201 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
offering |
string (uri) |
created |
string (date-time) |
file |
string (uri) |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_offering_files_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Marketplace Offering Permissions Log
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/marketplace-offering-permissions-log/ |
List Marketplace Offering Permissions Log |
| GET | /api/marketplace-offering-permissions-log/{id}/ |
Retrieve |
List Marketplace Offering Permissions Log
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 | |
- Model Source:
OfferingPermissionOEnum - API Source:
marketplace_offering_permissions_log_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
created |
string (date-time) | Created after |
customer |
string (uuid) | |
full_name |
string | User full name contains |
modified |
string (date-time) | Modified after |
native_name |
string | |
o |
array | Ordering |
offering |
string (uuid) | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
role_name |
string | Role name contains |
role_uuid |
string (uuid) | Role UUID |
scope_name |
string | Scope name |
scope_type |
string | Scope type |
scope_uuid |
string | Scope UUID |
user |
string (uuid) | |
user_slug |
string | User slug contains |
user_url |
string (uri) | |
username |
string |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
pk |
integer | |
created |
string (date-time) | |
expiration_time |
string (date-time) | |
created_by |
string (uri) | |
offering |
string (uri) | |
offering_uuid |
string (uuid) | |
offering_slug |
string | |
offering_name |
string | |
role |
string (uri) | |
role_name |
string | |
user |
string (uri) | |
user_full_name |
string | |
user_native_name |
string | |
user_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
user_uuid |
string (uuid) | |
user_email |
string (email) |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_offering_permissions_log_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required | Description |
|---|---|---|---|
id |
integer | ✓ | A unique integer value identifying this user role. |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
pk |
integer | |
created |
string (date-time) | |
expiration_time |
string (date-time) | |
created_by |
string (uri) | |
offering |
string (uri) | |
offering_uuid |
string (uuid) | |
offering_slug |
string | |
offering_name |
string | |
role |
string (uri) | |
role_name |
string | |
user |
string (uri) | |
user_full_name |
string | |
user_native_name |
string | |
user_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
user_uuid |
string (uuid) | |
user_email |
string (email) |
Marketplace Offering Permissions
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/marketplace-offering-permissions/ |
List Marketplace Offering Permissions |
| GET | /api/marketplace-offering-permissions/{id}/ |
Retrieve |
List Marketplace Offering Permissions
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 | |
- Model Source:
OfferingPermissionOEnum - API Source:
marketplace_offering_permissions_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
created |
string (date-time) | Created after |
customer |
string (uuid) | |
full_name |
string | User full name contains |
modified |
string (date-time) | Modified after |
native_name |
string | |
o |
array | Ordering |
offering |
string (uuid) | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
role_name |
string | Role name contains |
role_uuid |
string (uuid) | Role UUID |
scope_name |
string | Scope name |
scope_type |
string | Scope type |
scope_uuid |
string | Scope UUID |
user |
string (uuid) | |
user_slug |
string | User slug contains |
user_url |
string (uri) | |
username |
string |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
pk |
integer | |
created |
string (date-time) | |
expiration_time |
string (date-time) | |
created_by |
string (uri) | |
offering |
string (uri) | |
offering_uuid |
string (uuid) | |
offering_slug |
string | |
offering_name |
string | |
role |
string (uri) | |
role_name |
string | |
user |
string (uri) | |
user_full_name |
string | |
user_native_name |
string | |
user_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
user_uuid |
string (uuid) | |
user_email |
string (email) |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_offering_permissions_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required | Description |
|---|---|---|---|
id |
integer | ✓ | A unique integer value identifying this user role. |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
pk |
integer | |
created |
string (date-time) | |
expiration_time |
string (date-time) | |
created_by |
string (uri) | |
offering |
string (uri) | |
offering_uuid |
string (uuid) | |
offering_slug |
string | |
offering_name |
string | |
role |
string (uri) | |
role_name |
string | |
user |
string (uri) | |
user_full_name |
string | |
user_native_name |
string | |
user_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
user_uuid |
string (uuid) | |
user_email |
string (email) |
Marketplace Offering Referrals
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/marketplace-offering-referrals/ |
List Datacite referrals for offerings |
| GET | /api/marketplace-offering-referrals/{uuid}/ |
Retrieve a specific Datacite referral |
List Datacite referrals for offerings
Returns a paginated list of Datacite referrals associated with marketplace offerings. Referrals represent relationships between an offering (identified by a DOI) and other research outputs, such as publications or datasets. The list must be filtered by the offering's scope.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 | |
- Model Source:
OfferingReferralOEnum - API Source:
marketplace_offering_referrals_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
o |
array | Ordering |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
scope |
string (uri) | Filter by scope URL. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
scope |
string |
scope_uuid |
string (uuid) |
pid |
string |
relation_type |
string |
resource_type |
string |
creator |
string |
publisher |
string |
published |
string |
title |
string |
referral_url |
string |
Retrieve a specific Datacite referral
Returns the details of a single Datacite referral record, identified by its UUID. Details include the related identifier (PID), the type of relationship, and metadata about the related work.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_offering_referrals_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
scope |
string |
scope_uuid |
string (uuid) |
pid |
string |
relation_type |
string |
resource_type |
string |
creator |
string |
publisher |
string |
published |
string |
title |
string |
referral_url |
string |
Marketplace Offering Terms Of Service
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/marketplace-offering-terms-of-service/ |
List Terms of Service configurations |
| GET | /api/marketplace-offering-terms-of-service/{uuid}/ |
Retrieve a Terms of Service configuration |
| POST | /api/marketplace-offering-terms-of-service/ |
Create a Terms of Service configuration |
| PUT | /api/marketplace-offering-terms-of-service/{uuid}/ |
Update a Terms of Service configuration |
| PATCH | /api/marketplace-offering-terms-of-service/{uuid}/ |
Partially update a Terms of Service configuration |
| DELETE | /api/marketplace-offering-terms-of-service/{uuid}/ |
Delete a Terms of Service configuration |
List Terms of Service configurations
Returns a paginated list of Terms of Service configurations for offerings. Visibility depends on user permissions: staff/support see all; service providers see their own; regular users see ToS for offerings they have consented to or shared offerings.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 | |
- Model Source:
OfferingTermsOfServiceOEnum - API Source:
marketplace_offering_terms_of_service_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
is_active |
boolean | Is active |
o |
array | Ordering |
offering |
string (uri) | Offering URL |
offering_uuid |
string (uuid) | Offering UUID |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
requires_reconsent |
boolean | Requires reconsent |
version |
string | Version |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
offering_uuid |
string (uuid) | |
offering_name |
string | |
terms_of_service |
string | |
terms_of_service_link |
string (uri) | |
version |
string | |
is_active |
boolean | |
requires_reconsent |
boolean | If True, user will be asked to re-consent to the terms of service when the terms of service are updated. |
grace_period_days |
integer | Number of days before outdated consents are automatically revoked. Only applies when requires_reconsent=True. |
user_consent |
any | |
has_user_consent |
boolean | |
created |
string (date-time) | |
modified |
string (date-time) |
Retrieve a Terms of Service configuration
Returns the details of a specific Terms of Service configuration.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_offering_terms_of_service_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
offering_uuid |
string (uuid) | |
offering_name |
string | |
terms_of_service |
string | |
terms_of_service_link |
string (uri) | |
version |
string | |
is_active |
boolean | |
requires_reconsent |
boolean | If True, user will be asked to re-consent to the terms of service when the terms of service are updated. |
grace_period_days |
integer | Number of days before outdated consents are automatically revoked. Only applies when requires_reconsent=True. |
user_consent |
any | |
has_user_consent |
boolean | |
created |
string (date-time) | |
modified |
string (date-time) |
Create a Terms of Service configuration
Creates a new Terms of Service configuration for an offering. Only one active ToS configuration is allowed per offering.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
- Model Source:
OfferingTermsOfServiceCreateRequest - API Source:
marketplace_offering_terms_of_service_create
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Field | Type | Required | Description |
|---|---|---|---|
offering |
string (uri) | ✓ | |
terms_of_service |
string | ||
terms_of_service_link |
string (uri) | ||
version |
string | ||
is_active |
boolean | ||
requires_reconsent |
boolean | If True, user will be asked to re-consent to the terms of service when the terms of service are updated. | |
grace_period_days |
integer | Number of days before outdated consents are automatically revoked. Only applies when requires_reconsent=True. |
201 -
| Field | Type | Description |
|---|---|---|
offering |
string (uri) | |
terms_of_service |
string | |
terms_of_service_link |
string (uri) | |
version |
string | |
is_active |
boolean | |
requires_reconsent |
boolean | If True, user will be asked to re-consent to the terms of service when the terms of service are updated. |
grace_period_days |
integer | Number of days before outdated consents are automatically revoked. Only applies when requires_reconsent=True. |
Update a Terms of Service configuration
Updates an existing Terms of Service configuration. Note that some fields like version and requires_reconsent are protected and cannot be changed after creation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
OfferingTermsOfServiceRequest - API Source:
marketplace_offering_terms_of_service_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
terms_of_service |
string | ||
terms_of_service_link |
string (uri) | ||
is_active |
boolean | ||
grace_period_days |
integer | Number of days before outdated consents are automatically revoked. Only applies when requires_reconsent=True. |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
offering_uuid |
string (uuid) | |
offering_name |
string | |
terms_of_service |
string | |
terms_of_service_link |
string (uri) | |
version |
string | |
is_active |
boolean | |
requires_reconsent |
boolean | If True, user will be asked to re-consent to the terms of service when the terms of service are updated. |
grace_period_days |
integer | Number of days before outdated consents are automatically revoked. Only applies when requires_reconsent=True. |
user_consent |
any | |
has_user_consent |
boolean | |
created |
string (date-time) | |
modified |
string (date-time) |
Partially update a Terms of Service configuration
Partially updates an existing Terms of Service configuration.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedOfferingTermsOfServiceRequest - API Source:
marketplace_offering_terms_of_service_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
terms_of_service |
string | ||
terms_of_service_link |
string (uri) | ||
is_active |
boolean | ||
grace_period_days |
integer | Number of days before outdated consents are automatically revoked. Only applies when requires_reconsent=True. |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
offering_uuid |
string (uuid) | |
offering_name |
string | |
terms_of_service |
string | |
terms_of_service_link |
string (uri) | |
version |
string | |
is_active |
boolean | |
requires_reconsent |
boolean | If True, user will be asked to re-consent to the terms of service when the terms of service are updated. |
grace_period_days |
integer | Number of days before outdated consents are automatically revoked. Only applies when requires_reconsent=True. |
user_consent |
any | |
has_user_consent |
boolean | |
created |
string (date-time) | |
modified |
string (date-time) |
Delete a Terms of Service configuration
Deletes a Terms of Service configuration. This is a hard delete and should be used with caution.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_offering_terms_of_service_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Marketplace Plan Components
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/marketplace-plan-components/ |
List plan components |
| GET | /api/marketplace-plan-components/{id}/ |
Retrieve a plan component |
List plan components
Returns a paginated list of all plan components. A plan component defines the pricing and quotas for an offering component within a billing plan. The list is filtered based on the current user's access permissions and organization group memberships.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
marketplace_plan_components_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
archived |
boolean | Archived |
offering_uuid |
string (uuid) | Offering UUID |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
plan_uuid |
string (uuid) | Plan UUID |
shared |
boolean | Shared |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
offering_uuid |
string (uuid) | |
offering_name |
string | |
plan_uuid |
string (uuid) | |
plan_name |
string | |
plan_unit |
any | |
component_name |
string | Display name for the measured unit, for example, Floating IP. |
measured_unit |
string | Unit of measurement, for example, GB. |
billing_type |
any | |
amount |
integer | |
price |
string (decimal) | |
future_price |
string (decimal) | |
discount_threshold |
integer | Minimum amount to be eligible for discount. |
discount_rate |
integer | Discount rate in percentage. |
Retrieve a plan component
Returns the details of a specific plan component, including its pricing, quotas, and associated offering and plan information.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_plan_components_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required | Description |
|---|---|---|---|
id |
integer | ✓ | A unique integer value identifying this plan component. |
200 -
| Field | Type | Description |
|---|---|---|
offering_uuid |
string (uuid) | |
offering_name |
string | |
plan_uuid |
string (uuid) | |
plan_name |
string | |
plan_unit |
any | |
component_name |
string | Display name for the measured unit, for example, Floating IP. |
measured_unit |
string | Unit of measurement, for example, GB. |
billing_type |
any | |
amount |
integer | |
price |
string (decimal) | |
future_price |
string (decimal) | |
discount_threshold |
integer | Minimum amount to be eligible for discount. |
discount_rate |
integer | Discount rate in percentage. |
Marketplace Plans
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/marketplace-plans/ |
List provider plans |
| GET | /api/marketplace-plans/{uuid}/ |
Retrieve a provider plan |
| POST | /api/marketplace-plans/ |
Create a provider plan |
| POST | /api/marketplace-plans/{uuid}/update_discounts/ |
Update plan component discounts |
| POST | /api/marketplace-plans/{uuid}/update_organization_groups/ |
Update organization groups for a plan |
| POST | /api/marketplace-plans/{uuid}/update_prices/ |
Update plan component prices |
| POST | /api/marketplace-plans/{uuid}/update_quotas/ |
Update plan component quotas |
| PUT | /api/marketplace-plans/{uuid}/ |
Update a provider plan |
| PATCH | /api/marketplace-plans/{uuid}/ |
Partially update a provider plan |
| DELETE | /api/marketplace-plans/{uuid}/ |
Delete a provider plan |
| Other Actions | ||
| GET | /api/marketplace-plans/{uuid}/history/at/ |
Get object state at a specific timestamp |
| GET | /api/marketplace-plans/{uuid}/history/ |
Get version history |
| GET | /api/marketplace-plans/usage_stats/ |
Get plan usage statistics |
| POST | /api/marketplace-plans/{uuid}/archive/ |
Archive a plan |
| POST | /api/marketplace-plans/{uuid}/delete_organization_groups/ |
Remove all organization groups from a plan |
Core CRUD
List provider plans
Returns a paginated list of plans managed by the provider. The list is filtered based on the current user's access to the offering's customer.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
marketplace_plans_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
offering |
string (uri) | |
offering_slug |
array | Multiple values may be separated by commas. |
offering_uuid |
string (uuid) | Offering UUID |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
parent_offering_uuid |
string (uuid) |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
article_code |
string | |
max_amount |
integer | Maximum number of plans that could be active. Plan is disabled when maximum amount is reached. |
archived |
boolean | Forbids creation of new resources. |
is_active |
boolean | |
unit_price |
string (decimal) | |
unit |
string | Enum: month, quarter, half_month, day, hour, quantity |
init_price |
number (double) | |
switch_price |
number (double) | |
backend_id |
string | |
organization_groups |
array of objects | |
organization_groups.uuid |
string (uuid) | |
organization_groups.url |
string (uri) | |
organization_groups.name |
string | |
organization_groups.parent_uuid |
string (uuid) | UUID of the parent organization group |
organization_groups.parent_name |
string | Name of the parent organization group |
organization_groups.parent |
string (uri) | |
organization_groups.customers_count |
integer | Number of customers in this organization group |
components |
array of objects | |
components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
components.name |
string | Display name for the measured unit, for example, Floating IP. |
components.measured_unit |
string | Unit of measurement, for example, GB. |
components.amount |
integer | |
components.price |
string (decimal) | |
components.future_price |
string (decimal) | |
components.discount_threshold |
integer | Minimum amount to be eligible for discount. |
components.discount_rate |
integer | Discount rate in percentage. |
offering |
string (uri) | |
prices |
object (free-form) | |
future_prices |
object (free-form) | |
quotas |
object (free-form) | |
resources_count |
integer | |
plan_type |
string | |
minimal_price |
number (double) |
Retrieve a provider plan
Returns details of a specific plan.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_plans_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
article_code |
string | |
max_amount |
integer | Maximum number of plans that could be active. Plan is disabled when maximum amount is reached. |
archived |
boolean | Forbids creation of new resources. |
is_active |
boolean | |
unit_price |
string (decimal) | |
unit |
string | Enum: month, quarter, half_month, day, hour, quantity |
init_price |
number (double) | |
switch_price |
number (double) | |
backend_id |
string | |
organization_groups |
array of objects | |
organization_groups.uuid |
string (uuid) | |
organization_groups.url |
string (uri) | |
organization_groups.name |
string | |
organization_groups.parent_uuid |
string (uuid) | UUID of the parent organization group |
organization_groups.parent_name |
string | Name of the parent organization group |
organization_groups.parent |
string (uri) | |
organization_groups.customers_count |
integer | Number of customers in this organization group |
components |
array of objects | |
components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
components.name |
string | Display name for the measured unit, for example, Floating IP. |
components.measured_unit |
string | Unit of measurement, for example, GB. |
components.amount |
integer | |
components.price |
string (decimal) | |
components.future_price |
string (decimal) | |
components.discount_threshold |
integer | Minimum amount to be eligible for discount. |
components.discount_rate |
integer | Discount rate in percentage. |
offering |
string (uri) | |
prices |
object (free-form) | |
future_prices |
object (free-form) | |
quotas |
object (free-form) | |
resources_count |
integer | |
plan_type |
string | |
minimal_price |
number (double) |
Create a provider plan
Creates a new billing plan for an offering.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
ProviderPlanDetailsRequest - API Source:
marketplace_plans_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ✓ | |
description |
string | ||
article_code |
string | ||
max_amount |
integer | Maximum number of plans that could be active. Plan is disabled when maximum amount is reached. | |
archived |
boolean | Forbids creation of new resources. | |
unit_price |
string (decimal) | ||
unit |
string | Enum: month, quarter, half_month, day, hour, quantity |
|
backend_id |
string | ||
offering |
string (uri) | ✓ |
201 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
article_code |
string | |
max_amount |
integer | Maximum number of plans that could be active. Plan is disabled when maximum amount is reached. |
archived |
boolean | Forbids creation of new resources. |
is_active |
boolean | |
unit_price |
string (decimal) | |
unit |
string | Enum: month, quarter, half_month, day, hour, quantity |
init_price |
number (double) | |
switch_price |
number (double) | |
backend_id |
string | |
organization_groups |
array of objects | |
organization_groups.uuid |
string (uuid) | |
organization_groups.url |
string (uri) | |
organization_groups.name |
string | |
organization_groups.parent_uuid |
string (uuid) | UUID of the parent organization group |
organization_groups.parent_name |
string | Name of the parent organization group |
organization_groups.parent |
string (uri) | |
organization_groups.customers_count |
integer | Number of customers in this organization group |
components |
array of objects | |
components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
components.name |
string | Display name for the measured unit, for example, Floating IP. |
components.measured_unit |
string | Unit of measurement, for example, GB. |
components.amount |
integer | |
components.price |
string (decimal) | |
components.future_price |
string (decimal) | |
components.discount_threshold |
integer | Minimum amount to be eligible for discount. |
components.discount_rate |
integer | Discount rate in percentage. |
offering |
string (uri) | |
prices |
object (free-form) | |
future_prices |
object (free-form) | |
quotas |
object (free-form) | |
resources_count |
integer | |
plan_type |
string | |
minimal_price |
number (double) |
Update plan component discounts
1 2 3 4 5 6 7 8 9 | |
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
DiscountsUpdateRequest - API Source:
marketplace_plans_update_discounts
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
discounts |
object (free-form) | ✓ | Dictionary mapping component types to their discount configuration. |
200 - No response body
Update organization groups for a plan
Sets the list of organization groups that are allowed to access this plan. If the list is empty, the plan is accessible to all.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
OrganizationGroupsRequest - API Source:
marketplace_plans_update_organization_groups
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
organization_groups |
array of string (uri)s |
200 - No response body
Update plan component prices
Updates the prices for one or more components of a specific plan. If the plan is already in use by resources, this action updates the future_price, which will be applied from the next billing period. Otherwise, the current price is updated directly.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
PricesUpdateRequest - API Source:
marketplace_plans_update_prices
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
prices |
object (free-form) | ✓ |
200 - No response body
Update plan component quotas
Updates the quotas (fixed amounts) for one or more components of a specific plan. This is only applicable for components with a 'fixed-price' billing type.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
QuotasUpdateRequest - API Source:
marketplace_plans_update_quotas
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
quotas |
object (free-form) | ✓ | Dictionary of quotas to update |
200 - No response body
Update a provider plan
Updates an existing plan. Note: A plan cannot be updated if it is already used by resources.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
ProviderPlanDetailsRequest - API Source:
marketplace_plans_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ✓ | |
description |
string | ||
article_code |
string | ||
max_amount |
integer | Maximum number of plans that could be active. Plan is disabled when maximum amount is reached. | |
archived |
boolean | Forbids creation of new resources. | |
unit_price |
string (decimal) | ||
unit |
string | Enum: month, quarter, half_month, day, hour, quantity |
|
backend_id |
string | ||
offering |
string (uri) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
article_code |
string | |
max_amount |
integer | Maximum number of plans that could be active. Plan is disabled when maximum amount is reached. |
archived |
boolean | Forbids creation of new resources. |
is_active |
boolean | |
unit_price |
string (decimal) | |
unit |
string | Enum: month, quarter, half_month, day, hour, quantity |
init_price |
number (double) | |
switch_price |
number (double) | |
backend_id |
string | |
organization_groups |
array of objects | |
organization_groups.uuid |
string (uuid) | |
organization_groups.url |
string (uri) | |
organization_groups.name |
string | |
organization_groups.parent_uuid |
string (uuid) | UUID of the parent organization group |
organization_groups.parent_name |
string | Name of the parent organization group |
organization_groups.parent |
string (uri) | |
organization_groups.customers_count |
integer | Number of customers in this organization group |
components |
array of objects | |
components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
components.name |
string | Display name for the measured unit, for example, Floating IP. |
components.measured_unit |
string | Unit of measurement, for example, GB. |
components.amount |
integer | |
components.price |
string (decimal) | |
components.future_price |
string (decimal) | |
components.discount_threshold |
integer | Minimum amount to be eligible for discount. |
components.discount_rate |
integer | Discount rate in percentage. |
offering |
string (uri) | |
prices |
object (free-form) | |
future_prices |
object (free-form) | |
quotas |
object (free-form) | |
resources_count |
integer | |
plan_type |
string | |
minimal_price |
number (double) |
Partially update a provider plan
Partially updates an existing plan. Note: A plan cannot be updated if it is already used by resources.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedProviderPlanDetailsRequest - API Source:
marketplace_plans_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ||
description |
string | ||
article_code |
string | ||
max_amount |
integer | Maximum number of plans that could be active. Plan is disabled when maximum amount is reached. | |
archived |
boolean | Forbids creation of new resources. | |
unit_price |
string (decimal) | ||
unit |
string | Enum: month, quarter, half_month, day, hour, quantity |
|
backend_id |
string |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
article_code |
string | |
max_amount |
integer | Maximum number of plans that could be active. Plan is disabled when maximum amount is reached. |
archived |
boolean | Forbids creation of new resources. |
is_active |
boolean | |
unit_price |
string (decimal) | |
unit |
string | Enum: month, quarter, half_month, day, hour, quantity |
init_price |
number (double) | |
switch_price |
number (double) | |
backend_id |
string | |
organization_groups |
array of objects | |
organization_groups.uuid |
string (uuid) | |
organization_groups.url |
string (uri) | |
organization_groups.name |
string | |
organization_groups.parent_uuid |
string (uuid) | UUID of the parent organization group |
organization_groups.parent_name |
string | Name of the parent organization group |
organization_groups.parent |
string (uri) | |
organization_groups.customers_count |
integer | Number of customers in this organization group |
components |
array of objects | |
components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
components.name |
string | Display name for the measured unit, for example, Floating IP. |
components.measured_unit |
string | Unit of measurement, for example, GB. |
components.amount |
integer | |
components.price |
string (decimal) | |
components.future_price |
string (decimal) | |
components.discount_threshold |
integer | Minimum amount to be eligible for discount. |
components.discount_rate |
integer | Discount rate in percentage. |
offering |
string (uri) | |
prices |
object (free-form) | |
future_prices |
object (free-form) | |
quotas |
object (free-form) | |
resources_count |
integer | |
plan_type |
string | |
minimal_price |
number (double) |
Delete a provider plan
Deletes a plan. This is a hard delete and should be used with caution.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_plans_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
Get object state at a specific timestamp
Returns the state of the object as it was at the specified timestamp. Only accessible by staff and support users.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- API Source:
marketplace_plans_history_at_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Required | Description |
|---|---|---|---|
timestamp |
string | ✓ | ISO 8601 timestamp to query the object state at |
200 -
| Field | Type | Description |
|---|---|---|
id |
integer | Version ID |
revision_date |
string (date-time) | When this revision was created |
revision_user |
object (free-form) | User who created this revision |
revision_comment |
string | Comment describing the revision |
serialized_data |
object (free-form) | Serialized model fields at this revision |
400 -
404 -
Get version history
Returns the version history for this object. Only accessible by staff and support users.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- API Source:
marketplace_plans_history_list
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
created_after |
string | Filter versions created after this timestamp (ISO 8601) |
created_before |
string | Filter versions created before this timestamp (ISO 8601) |
offering |
string (uri) | |
offering_slug |
array | Multiple values may be separated by commas. |
offering_uuid |
string (uuid) | Offering UUID |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
parent_offering_uuid |
string (uuid) |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
id |
integer | Version ID |
revision_date |
string (date-time) | When this revision was created |
revision_user |
object (free-form) | User who created this revision |
revision_comment |
string | Comment describing the revision |
serialized_data |
object (free-form) | Serialized model fields at this revision |
Get plan usage statistics
Returns aggregated statistics on how many resources are currently using each plan. Can be filtered by offering or service provider.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
marketplace_plans_usage_stats_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
customer_provider_uuid |
string (uuid) | Filter by offering customer provider UUID. |
o |
string | Ordering field. Available options: usage, limit, remaining, and their descending counterparts (e.g., -usage). |
offering |
string (uri) | |
offering_slug |
array | Multiple values may be separated by commas. |
offering_uuid |
string (uuid) | Filter by offering UUID. |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
parent_offering_uuid |
string (uuid) |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
plan_uuid |
string (uuid) | UUID of the plan |
plan_name |
string | Name of the plan |
limit |
integer | Usage limit |
usage |
integer | Current usage count |
remaining |
integer | Remaining usage |
offering_uuid |
string (uuid) | |
offering_name |
string | |
customer_provider_uuid |
string (uuid) | |
customer_provider_name |
string |
Archive a plan
Marks a plan as archived. Archived plans cannot be used for provisioning new resources, but existing resources will continue to be billed according to this plan.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_plans_archive
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - No response body
Remove all organization groups from a plan
Removes all organization group associations from this plan, making it accessible to all users (subject to offering-level restrictions).
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_plans_delete_organization_groups
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Marketplace Public Offerings
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/marketplace-public-offerings/ |
List public offerings |
| GET | /api/marketplace-public-offerings/{uuid}/ |
Retrieve a public offering |
| Other Actions | ||
| GET | /api/marketplace-public-offerings/{uuid}/plans/ |
List plans for an offering |
| GET | /api/marketplace-public-offerings/{uuid}/plans/{plan_uuid}/ |
Retrieve a specific plan for an offering |
Core CRUD
List public offerings
Returns a paginated list of public offerings. The list is filtered to show only offerings that are active or paused and available for ordering by the current user. If anonymous access is enabled, it shows shared offerings available to unauthenticated users.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
OfferingState - Model Source:
ProviderOfferingDetailsOEnum - Model Source:
PublicOfferingDetailsFieldEnum - API Source:
marketplace_public_offerings_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
accessible_via_calls |
boolean | Accessible via calls |
allowed_customer_uuid |
string (uuid) | Allowed customer UUID |
attributes |
string | Offering attributes (JSON) |
billable |
boolean | Billable |
can_create_offering_user |
boolean | |
category_group_uuid |
string (uuid) | Category group UUID |
category_uuid |
string (uuid) | Category UUID |
created |
string (date-time) | Created after |
customer |
string (uri) | Customer URL |
customer_uuid |
string (uuid) | Customer UUID |
description |
string | Description contains |
field |
array | |
has_active_terms_of_service |
boolean | Has Active Terms of Service |
has_terms_of_service |
boolean | Has Terms of Service |
keyword |
string | Keyword |
modified |
string (date-time) | Modified after |
name |
string | Name |
name_exact |
string | Name (exact) |
o |
array | Ordering |
organization_group_uuid |
string (uuid) | Organization group UUID |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
parent_uuid |
string (uuid) | Parent offering UUID |
project_uuid |
string (uuid) | Project UUID |
query |
string | Search by offering name, slug or description |
resource_customer_uuid |
string (uuid) | Resource customer UUID |
resource_project_uuid |
string (uuid) | Resource project UUID |
scope_uuid |
string | Scope UUID |
service_manager_uuid |
string (uuid) | Service manager UUID |
shared |
boolean | Shared |
state |
array | Offering state |
tag |
array | Tag UUID (OR logic) |
tag_name |
array | Tag name (OR logic) |
tag_names_and |
string | Tag names with AND logic (comma-separated) |
tags_and |
string | Tag UUIDs with AND logic (comma-separated) |
type |
array | Offering type |
user_has_consent |
boolean | User Has Consent |
user_has_offering_user |
boolean | User Has Offering User |
uuid_list |
string | Comma-separated offering UUIDs |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
name |
string | |
slug |
string | URL-friendly identifier. Only editable by staff users. |
description |
string | |
full_description |
string | |
privacy_policy_link |
string (uri) | |
access_url |
string (uri) | Publicly accessible offering access URL |
endpoints |
array of objects | |
endpoints.uuid |
string (uuid) | |
endpoints.name |
string | |
endpoints.url |
string | URL of the access endpoint |
software_catalogs |
array of objects | |
software_catalogs.uuid |
string (uuid) | |
software_catalogs.catalog |
any | |
software_catalogs.enabled_cpu_family |
any | List of enabled CPU families: ['x86_64', 'aarch64'] |
software_catalogs.enabled_cpu_microarchitectures |
any | List of enabled CPU microarchitectures: ['generic', 'zen3'] |
software_catalogs.package_count |
integer | |
software_catalogs.partition |
any | |
partitions |
array of objects | |
partitions.uuid |
string (uuid) | |
partitions.partition_name |
string | Name of the SLURM partition |
partitions.cpu_bind |
integer | Default task binding policy (SLURM cpu_bind) |
partitions.def_cpu_per_gpu |
integer | Default CPUs allocated per GPU |
partitions.max_cpus_per_node |
integer | Maximum allocated CPUs per node |
partitions.max_cpus_per_socket |
integer | Maximum allocated CPUs per socket |
partitions.def_mem_per_cpu |
integer (int64) | Default memory per CPU in MB |
partitions.def_mem_per_gpu |
integer (int64) | Default memory per GPU in MB |
partitions.def_mem_per_node |
integer (int64) | Default memory per node in MB |
partitions.max_mem_per_cpu |
integer (int64) | Maximum memory per CPU in MB |
partitions.max_mem_per_node |
integer (int64) | Maximum memory per node in MB |
partitions.default_time |
integer | Default time limit in minutes |
partitions.max_time |
integer | Maximum time limit in minutes |
partitions.grace_time |
integer | Preemption grace time in seconds |
partitions.max_nodes |
integer | Maximum nodes per job |
partitions.min_nodes |
integer | Minimum nodes per job |
partitions.exclusive_topo |
boolean | Exclusive topology access required |
partitions.exclusive_user |
boolean | Exclusive user access required |
partitions.priority_tier |
integer | Priority tier for scheduling and preemption |
partitions.qos |
string | Quality of Service (QOS) name |
partitions.req_resv |
boolean | Require reservation for job allocation |
roles |
array of objects | |
roles.uuid |
string (uuid) | |
roles.name |
string | |
roles.url |
string (uri) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
project |
string (uri) | |
project_uuid |
string (uuid) | |
project_name |
string | |
category |
string (uri) | |
category_uuid |
string (uuid) | |
category_title |
string | |
attributes |
object (free-form) | |
options |
any | |
resource_options |
any | |
components |
array of objects | |
components.uuid |
string (uuid) | |
components.billing_type |
string | Enum: fixed, usage, limit, one, few |
components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
components.name |
string | Display name for the measured unit, for example, Floating IP. |
components.description |
string | |
components.measured_unit |
string | Unit of measurement, for example, GB. |
components.unit_factor |
integer | The conversion factor from backend units to measured_unit |
components.limit_period |
any | |
components.limit_amount |
integer | |
components.article_code |
string | |
components.max_value |
integer | |
components.min_value |
integer | |
components.max_available_limit |
integer | |
components.is_boolean |
boolean | |
components.default_limit |
integer | |
components.factor |
integer | |
components.is_builtin |
boolean | |
components.is_prepaid |
boolean | |
components.overage_component |
string (uuid) | |
components.min_prepaid_duration |
integer | |
components.max_prepaid_duration |
integer | |
plugin_options |
any | |
state |
any | |
vendor_details |
string | |
getting_started |
string | |
integration_guide |
string | |
thumbnail |
string (uri) | |
order_count |
integer | |
plans |
array of objects | |
plans.url |
string (uri) | |
plans.uuid |
string (uuid) | |
plans.name |
string | |
plans.description |
string | |
plans.article_code |
string | |
plans.max_amount |
integer | Maximum number of plans that could be active. Plan is disabled when maximum amount is reached. |
plans.archived |
boolean | Forbids creation of new resources. |
plans.is_active |
boolean | |
plans.unit_price |
string (decimal) | |
plans.unit |
string | Enum: month, quarter, half_month, day, hour, quantity |
plans.init_price |
number (double) | |
plans.switch_price |
number (double) | |
plans.backend_id |
string | |
plans.organization_groups |
array of objects | |
plans.organization_groups.uuid |
string (uuid) | |
plans.organization_groups.url |
string (uri) | |
plans.organization_groups.name |
string | |
plans.organization_groups.parent_uuid |
string (uuid) | UUID of the parent organization group |
plans.organization_groups.parent_name |
string | Name of the parent organization group |
plans.organization_groups.parent |
string (uri) | |
plans.organization_groups.customers_count |
integer | Number of customers in this organization group |
plans.components |
array of objects | |
plans.components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
plans.components.name |
string | Display name for the measured unit, for example, Floating IP. |
plans.components.measured_unit |
string | Unit of measurement, for example, GB. |
plans.components.amount |
integer | |
plans.components.price |
string (decimal) | |
plans.components.future_price |
string (decimal) | |
plans.components.discount_threshold |
integer | Minimum amount to be eligible for discount. |
plans.components.discount_rate |
integer | Discount rate in percentage. |
plans.prices |
object (free-form) | |
plans.future_prices |
object (free-form) | |
plans.quotas |
object (free-form) | |
plans.resources_count |
integer | |
plans.plan_type |
string | |
plans.minimal_price |
number (double) | |
screenshots |
array of objects | |
screenshots.name |
string | |
screenshots.uuid |
string (uuid) | |
screenshots.description |
string | |
screenshots.image |
string (uri) | |
screenshots.thumbnail |
string (uri) | |
screenshots.created |
string (date-time) | |
type |
string | |
shared |
boolean | Accessible to all customers. |
billable |
boolean | Purchase and usage is invoiced. |
scope |
string | |
scope_uuid |
string (uuid) | |
scope_name |
string (uuid) | |
scope_state |
any | |
scope_error_message |
string | |
files |
array of objects | |
files.name |
string | |
files.created |
string (date-time) | |
files.file |
string (uri) | |
quotas |
array of objects | |
quotas.name |
string | |
quotas.usage |
integer | |
quotas.limit |
integer | |
paused_reason |
string | |
datacite_doi |
string | |
citation_count |
integer | Number of citations of a DOI |
latitude |
number (double) | |
longitude |
number (double) | |
country |
any | Country code (ISO 3166-1 alpha-2) |
backend_id |
string | |
organization_groups |
array of objects | |
organization_groups.uuid |
string (uuid) | |
organization_groups.url |
string (uri) | |
organization_groups.name |
string | |
organization_groups.parent_uuid |
string (uuid) | UUID of the parent organization group |
organization_groups.parent_name |
string | Name of the parent organization group |
organization_groups.parent |
string (uri) | |
organization_groups.customers_count |
integer | Number of customers in this organization group |
tags |
array of objects | |
tags.uuid |
string (uuid) | |
tags.name |
string | |
image |
string (uri) | |
total_customers |
integer | |
total_cost |
integer | |
total_cost_estimated |
integer | |
parent_description |
string | |
parent_uuid |
string (uuid) | |
parent_name |
string | |
backend_metadata |
any | |
has_compliance_requirements |
boolean | |
billing_type_classification |
string | Classify offering components by billing type. Returns 'limit_only', 'usage_only', or 'mixed'. |
compliance_checklist |
string (uri) | |
user_has_consent |
boolean | |
is_accessible |
boolean | |
google_calendar_is_public |
boolean | |
google_calendar_link |
string | Get the Google Calendar link for an offering. |
promotion_campaigns |
array of objects | |
promotion_campaigns.uuid |
string (uuid) | |
promotion_campaigns.name |
string | |
promotion_campaigns.start_date |
string (date) | Starting from this date, the campaign is active. |
promotion_campaigns.end_date |
string (date) | The last day the campaign is active. |
promotion_campaigns.discount_type |
string | Enum: discount, special_price |
promotion_campaigns.discount |
integer | |
promotion_campaigns.stock |
integer | |
promotion_campaigns.description |
string | |
promotion_campaigns.months |
integer | How many months in a row should the related service (when activated) get special deal (0 for indefinitely until active) |
promotion_campaigns.service_provider |
string (uri) |
Retrieve a public offering
Returns the details of a specific public offering. Access is granted if the offering is available for ordering by the current user or if anonymous access is enabled.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
PublicOfferingDetailsFieldEnum - API Source:
marketplace_public_offerings_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
name |
string | |
slug |
string | URL-friendly identifier. Only editable by staff users. |
description |
string | |
full_description |
string | |
privacy_policy_link |
string (uri) | |
access_url |
string (uri) | Publicly accessible offering access URL |
endpoints |
array of objects | |
endpoints.uuid |
string (uuid) | |
endpoints.name |
string | |
endpoints.url |
string | URL of the access endpoint |
software_catalogs |
array of objects | |
software_catalogs.uuid |
string (uuid) | |
software_catalogs.catalog |
any | |
software_catalogs.enabled_cpu_family |
any | List of enabled CPU families: ['x86_64', 'aarch64'] |
software_catalogs.enabled_cpu_microarchitectures |
any | List of enabled CPU microarchitectures: ['generic', 'zen3'] |
software_catalogs.package_count |
integer | |
software_catalogs.partition |
any | |
partitions |
array of objects | |
partitions.uuid |
string (uuid) | |
partitions.partition_name |
string | Name of the SLURM partition |
partitions.cpu_bind |
integer | Default task binding policy (SLURM cpu_bind) |
partitions.def_cpu_per_gpu |
integer | Default CPUs allocated per GPU |
partitions.max_cpus_per_node |
integer | Maximum allocated CPUs per node |
partitions.max_cpus_per_socket |
integer | Maximum allocated CPUs per socket |
partitions.def_mem_per_cpu |
integer (int64) | Default memory per CPU in MB |
partitions.def_mem_per_gpu |
integer (int64) | Default memory per GPU in MB |
partitions.def_mem_per_node |
integer (int64) | Default memory per node in MB |
partitions.max_mem_per_cpu |
integer (int64) | Maximum memory per CPU in MB |
partitions.max_mem_per_node |
integer (int64) | Maximum memory per node in MB |
partitions.default_time |
integer | Default time limit in minutes |
partitions.max_time |
integer | Maximum time limit in minutes |
partitions.grace_time |
integer | Preemption grace time in seconds |
partitions.max_nodes |
integer | Maximum nodes per job |
partitions.min_nodes |
integer | Minimum nodes per job |
partitions.exclusive_topo |
boolean | Exclusive topology access required |
partitions.exclusive_user |
boolean | Exclusive user access required |
partitions.priority_tier |
integer | Priority tier for scheduling and preemption |
partitions.qos |
string | Quality of Service (QOS) name |
partitions.req_resv |
boolean | Require reservation for job allocation |
roles |
array of objects | |
roles.uuid |
string (uuid) | |
roles.name |
string | |
roles.url |
string (uri) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
project |
string (uri) | |
project_uuid |
string (uuid) | |
project_name |
string | |
category |
string (uri) | |
category_uuid |
string (uuid) | |
category_title |
string | |
attributes |
object (free-form) | |
options |
any | |
resource_options |
any | |
components |
array of objects | |
components.uuid |
string (uuid) | |
components.billing_type |
string | Enum: fixed, usage, limit, one, few |
components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
components.name |
string | Display name for the measured unit, for example, Floating IP. |
components.description |
string | |
components.measured_unit |
string | Unit of measurement, for example, GB. |
components.unit_factor |
integer | The conversion factor from backend units to measured_unit |
components.limit_period |
any | |
components.limit_amount |
integer | |
components.article_code |
string | |
components.max_value |
integer | |
components.min_value |
integer | |
components.max_available_limit |
integer | |
components.is_boolean |
boolean | |
components.default_limit |
integer | |
components.factor |
integer | |
components.is_builtin |
boolean | |
components.is_prepaid |
boolean | |
components.overage_component |
string (uuid) | |
components.min_prepaid_duration |
integer | |
components.max_prepaid_duration |
integer | |
plugin_options |
any | |
state |
any | |
vendor_details |
string | |
getting_started |
string | |
integration_guide |
string | |
thumbnail |
string (uri) | |
order_count |
integer | |
plans |
array of objects | |
plans.url |
string (uri) | |
plans.uuid |
string (uuid) | |
plans.name |
string | |
plans.description |
string | |
plans.article_code |
string | |
plans.max_amount |
integer | Maximum number of plans that could be active. Plan is disabled when maximum amount is reached. |
plans.archived |
boolean | Forbids creation of new resources. |
plans.is_active |
boolean | |
plans.unit_price |
string (decimal) | |
plans.unit |
string | Enum: month, quarter, half_month, day, hour, quantity |
plans.init_price |
number (double) | |
plans.switch_price |
number (double) | |
plans.backend_id |
string | |
plans.organization_groups |
array of objects | |
plans.organization_groups.uuid |
string (uuid) | |
plans.organization_groups.url |
string (uri) | |
plans.organization_groups.name |
string | |
plans.organization_groups.parent_uuid |
string (uuid) | UUID of the parent organization group |
plans.organization_groups.parent_name |
string | Name of the parent organization group |
plans.organization_groups.parent |
string (uri) | |
plans.organization_groups.customers_count |
integer | Number of customers in this organization group |
plans.components |
array of objects | |
plans.components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
plans.components.name |
string | Display name for the measured unit, for example, Floating IP. |
plans.components.measured_unit |
string | Unit of measurement, for example, GB. |
plans.components.amount |
integer | |
plans.components.price |
string (decimal) | |
plans.components.future_price |
string (decimal) | |
plans.components.discount_threshold |
integer | Minimum amount to be eligible for discount. |
plans.components.discount_rate |
integer | Discount rate in percentage. |
plans.prices |
object (free-form) | |
plans.future_prices |
object (free-form) | |
plans.quotas |
object (free-form) | |
plans.resources_count |
integer | |
plans.plan_type |
string | |
plans.minimal_price |
number (double) | |
screenshots |
array of objects | |
screenshots.name |
string | |
screenshots.uuid |
string (uuid) | |
screenshots.description |
string | |
screenshots.image |
string (uri) | |
screenshots.thumbnail |
string (uri) | |
screenshots.created |
string (date-time) | |
type |
string | |
shared |
boolean | Accessible to all customers. |
billable |
boolean | Purchase and usage is invoiced. |
scope |
string | |
scope_uuid |
string (uuid) | |
scope_name |
string (uuid) | |
scope_state |
any | |
scope_error_message |
string | |
files |
array of objects | |
files.name |
string | |
files.created |
string (date-time) | |
files.file |
string (uri) | |
quotas |
array of objects | |
quotas.name |
string | |
quotas.usage |
integer | |
quotas.limit |
integer | |
paused_reason |
string | |
datacite_doi |
string | |
citation_count |
integer | Number of citations of a DOI |
latitude |
number (double) | |
longitude |
number (double) | |
country |
any | Country code (ISO 3166-1 alpha-2) |
backend_id |
string | |
organization_groups |
array of objects | |
organization_groups.uuid |
string (uuid) | |
organization_groups.url |
string (uri) | |
organization_groups.name |
string | |
organization_groups.parent_uuid |
string (uuid) | UUID of the parent organization group |
organization_groups.parent_name |
string | Name of the parent organization group |
organization_groups.parent |
string (uri) | |
organization_groups.customers_count |
integer | Number of customers in this organization group |
tags |
array of objects | |
tags.uuid |
string (uuid) | |
tags.name |
string | |
image |
string (uri) | |
total_customers |
integer | |
total_cost |
integer | |
total_cost_estimated |
integer | |
parent_description |
string | |
parent_uuid |
string (uuid) | |
parent_name |
string | |
backend_metadata |
any | |
has_compliance_requirements |
boolean | |
billing_type_classification |
string | Classify offering components by billing type. Returns 'limit_only', 'usage_only', or 'mixed'. |
compliance_checklist |
string (uri) | |
user_has_consent |
boolean | |
is_accessible |
boolean | |
google_calendar_is_public |
boolean | |
google_calendar_link |
string | Get the Google Calendar link for an offering. |
promotion_campaigns |
array of objects | |
promotion_campaigns.uuid |
string (uuid) | |
promotion_campaigns.name |
string | |
promotion_campaigns.start_date |
string (date) | Starting from this date, the campaign is active. |
promotion_campaigns.end_date |
string (date) | The last day the campaign is active. |
promotion_campaigns.discount_type |
string | Enum: discount, special_price |
promotion_campaigns.discount |
integer | |
promotion_campaigns.stock |
integer | |
promotion_campaigns.description |
string | |
promotion_campaigns.months |
integer | How many months in a row should the related service (when activated) get special deal (0 for indefinitely until active) |
promotion_campaigns.service_provider |
string (uri) |
Other Actions
List plans for an offering
Returns a list of plans available for a specific offering. The plans are filtered based on the current user's permissions and organization group memberships.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- API Source:
marketplace_public_offerings_plans_list
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
article_code |
string | |
max_amount |
integer | Maximum number of plans that could be active. Plan is disabled when maximum amount is reached. |
archived |
boolean | Forbids creation of new resources. |
is_active |
boolean | |
unit_price |
string (decimal) | |
unit |
string | Enum: month, quarter, half_month, day, hour, quantity |
init_price |
number (double) | |
switch_price |
number (double) | |
backend_id |
string | |
organization_groups |
array of objects | |
organization_groups.uuid |
string (uuid) | |
organization_groups.url |
string (uri) | |
organization_groups.name |
string | |
organization_groups.parent_uuid |
string (uuid) | UUID of the parent organization group |
organization_groups.parent_name |
string | Name of the parent organization group |
organization_groups.parent |
string (uri) | |
organization_groups.customers_count |
integer | Number of customers in this organization group |
components |
array of objects | |
components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
components.name |
string | Display name for the measured unit, for example, Floating IP. |
components.measured_unit |
string | Unit of measurement, for example, GB. |
components.amount |
integer | |
components.price |
string (decimal) | |
components.future_price |
string (decimal) | |
components.discount_threshold |
integer | Minimum amount to be eligible for discount. |
components.discount_rate |
integer | Discount rate in percentage. |
prices |
object (free-form) | |
future_prices |
object (free-form) | |
quotas |
object (free-form) | |
resources_count |
integer | |
plan_type |
string | |
minimal_price |
number (double) |
Retrieve a specific plan for an offering
Returns the details of a specific plan if it is available to the current user for the given offering.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- API Source:
marketplace_public_offerings_plans_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Name | Type | Required |
|---|---|---|
plan_uuid |
string | ✓ |
uuid |
string | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
article_code |
string | |
max_amount |
integer | Maximum number of plans that could be active. Plan is disabled when maximum amount is reached. |
archived |
boolean | Forbids creation of new resources. |
is_active |
boolean | |
unit_price |
string (decimal) | |
unit |
string | Enum: month, quarter, half_month, day, hour, quantity |
init_price |
number (double) | |
switch_price |
number (double) | |
backend_id |
string | |
organization_groups |
array of objects | |
organization_groups.uuid |
string (uuid) | |
organization_groups.url |
string (uri) | |
organization_groups.name |
string | |
organization_groups.parent_uuid |
string (uuid) | UUID of the parent organization group |
organization_groups.parent_name |
string | Name of the parent organization group |
organization_groups.parent |
string (uri) | |
organization_groups.customers_count |
integer | Number of customers in this organization group |
components |
array of objects | |
components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
components.name |
string | Display name for the measured unit, for example, Floating IP. |
components.measured_unit |
string | Unit of measurement, for example, GB. |
components.amount |
integer | |
components.price |
string (decimal) | |
components.future_price |
string (decimal) | |
components.discount_threshold |
integer | Minimum amount to be eligible for discount. |
components.discount_rate |
integer | Discount rate in percentage. |
prices |
object (free-form) | |
future_prices |
object (free-form) | |
quotas |
object (free-form) | |
resources_count |
integer | |
plan_type |
string | |
minimal_price |
number (double) |
Marketplace Resource Offerings
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/marketplace-resource-offerings/{category_uuid}/ |
Retrieve |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- API Source:
marketplace_resource_offerings_list
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
category_uuid |
string | ✓ |
| Name | Type | Description |
|---|---|---|
name |
string | Name |
name_exact |
string | Name (exact) |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
name |
string |
uuid |
string (uuid) |
Marketplace Screenshots
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/marketplace-screenshots/ |
List Marketplace Screenshots |
| GET | /api/marketplace-screenshots/{uuid}/ |
Retrieve |
| POST | /api/marketplace-screenshots/ |
Create |
| PUT | /api/marketplace-screenshots/{uuid}/ |
Update |
| PATCH | /api/marketplace-screenshots/{uuid}/ |
Partial Update |
| DELETE | /api/marketplace-screenshots/{uuid}/ |
Delete |
List Marketplace Screenshots
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 | |
- Model Source:
MaintenanceAnnouncementTemplateOEnum - API Source:
marketplace_screenshots_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
o |
array | Ordering |
offering |
string (uri) | |
offering_slug |
array | Multiple values may be separated by commas. |
offering_uuid |
array | Multiple values may be separated by commas. |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
parent_offering_uuid |
string (uuid) |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
created |
string (date-time) |
description |
string |
image |
string (uri) |
thumbnail |
string (uri) |
offering |
string (uri) |
customer_uuid |
string (uuid) |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_screenshots_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
created |
string (date-time) |
description |
string |
image |
string (uri) |
thumbnail |
string (uri) |
offering |
string (uri) |
customer_uuid |
string (uuid) |
Create
1 2 3 4 5 6 7 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
ScreenshotRequest - API Source:
marketplace_screenshots_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
| Field | Type | Required |
|---|---|---|
name |
string | ✓ |
description |
string | |
image |
string (binary) | ✓ |
offering |
string (uri) | ✓ |
201 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
created |
string (date-time) |
description |
string |
image |
string (uri) |
thumbnail |
string (uri) |
offering |
string (uri) |
customer_uuid |
string (uuid) |
Update
1 2 3 4 5 6 7 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | |
- Model Source:
ScreenshotRequest - API Source:
marketplace_screenshots_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
name |
string | ✓ |
description |
string | |
image |
string (binary) | ✓ |
offering |
string (uri) | ✓ |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
created |
string (date-time) |
description |
string |
image |
string (uri) |
thumbnail |
string (uri) |
offering |
string (uri) |
customer_uuid |
string (uuid) |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedScreenshotRequest - API Source:
marketplace_screenshots_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
name |
string | |
description |
string |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
created |
string (date-time) |
description |
string |
image |
string (uri) |
thumbnail |
string (uri) |
offering |
string (uri) |
customer_uuid |
string (uuid) |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_screenshots_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Service Settings
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/service-settings/ |
List Service Settings |
| GET | /api/service-settings/{uuid}/ |
Retrieve |
List Service Settings
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- Model Source:
CoreStates - Model Source:
ServiceSettingsFieldEnum - API Source:
service_settings_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
customer |
string (uuid) | Customer UUID |
customer_uuid |
string (uuid) | Customer UUID |
field |
array | |
name |
string | Name |
name_exact |
string | Name (exact) |
o |
string | Which field to use when ordering the results. |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
scope |
string (uri) | Filter by scope URL. |
scope_uuid |
string | Scope UUID |
shared |
boolean | |
state |
array | State |
type |
string | Type |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
type |
string | |
state |
any | |
error_message |
string | |
shared |
boolean | Anybody can use it |
customer |
string (uri) | |
customer_name |
string | |
customer_native_name |
string | |
terms_of_services |
string (uri) | |
scope |
string | |
scope_uuid |
string (uuid) | |
options |
object (free-form) |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
ServiceSettingsFieldEnum - API Source:
service_settings_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
type |
string | |
state |
any | |
error_message |
string | |
shared |
boolean | Anybody can use it |
customer |
string (uri) | |
customer_name |
string | |
customer_native_name |
string | |
terms_of_services |
string (uri) | |
scope |
string | |
scope_uuid |
string (uuid) | |
options |
object (free-form) |
Marketplace Tags
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/marketplace-tags/ |
List Marketplace Tags |
| GET | /api/marketplace-tags/{uuid}/ |
Retrieve |
| POST | /api/marketplace-tags/ |
Create |
| PUT | /api/marketplace-tags/{uuid}/ |
Update |
| PATCH | /api/marketplace-tags/{uuid}/ |
Partial Update |
| DELETE | /api/marketplace-tags/{uuid}/ |
Delete |
List Marketplace Tags
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
marketplace_tags_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
created_by |
string (uuid) | |
name |
string | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
offering_count |
integer | Return offering count filtered by user permissions. Staff sees all offerings. Service providers see their own + active/paused/archived public offerings. |
created |
string (date-time) | |
created_by_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
created_by_full_name |
string |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_tags_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
offering_count |
integer | Return offering count filtered by user permissions. Staff sees all offerings. Service providers see their own + active/paused/archived public offerings. |
created |
string (date-time) | |
created_by_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
created_by_full_name |
string |
Create
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
- Model Source:
TagRequest - API Source:
marketplace_tags_create
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Field | Type | Required |
|---|---|---|
name |
string | ✓ |
description |
string |
201 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
offering_count |
integer | Return offering count filtered by user permissions. Staff sees all offerings. Service providers see their own + active/paused/archived public offerings. |
created |
string (date-time) | |
created_by_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
created_by_full_name |
string |
Update
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
TagRequest - API Source:
marketplace_tags_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
name |
string | ✓ |
description |
string |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
offering_count |
integer | Return offering count filtered by user permissions. Staff sees all offerings. Service providers see their own + active/paused/archived public offerings. |
created |
string (date-time) | |
created_by_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
created_by_full_name |
string |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedTagRequest - API Source:
marketplace_tags_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
name |
string | |
description |
string |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
description |
string | |
offering_count |
integer | Return offering count filtered by user permissions. Staff sees all offerings. Service providers see their own + active/paused/archived public offerings. |
created |
string (date-time) | |
created_by_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
created_by_full_name |
string |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_tags_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Onboarding
Onboarding Justifications
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/onboarding-justifications/ |
List Onboarding Justifications |
| GET | /api/onboarding-justifications/{uuid}/ |
Retrieve |
| POST | /api/onboarding-justifications/ |
Create |
| POST | /api/onboarding-justifications/create_justification/ |
Create justification for failed verification |
| PUT | /api/onboarding-justifications/{uuid}/ |
Update |
| PATCH | /api/onboarding-justifications/{uuid}/ |
Partial Update |
| DELETE | /api/onboarding-justifications/{uuid}/ |
Delete |
| Other Actions | ||
| POST | /api/onboarding-justifications/{uuid}/approve/ |
Approve justification and mark verification as VERIFIED |
| POST | /api/onboarding-justifications/{uuid}/attach_document/ |
Attach supporting document to justification |
| POST | /api/onboarding-justifications/{uuid}/reject/ |
Reject justification and mark verification as FAILED |
Core CRUD
List Onboarding Justifications
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- Model Source:
OnboardingJustificationOEnum - Model Source:
OnboardingJustificationValidationDecisionEnum - API Source:
onboarding_justifications_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
o |
array | Ordering |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
query |
string | Filter by legal name, legal person identifier |
user_uuid |
string (uuid) | User UUID |
validation_decision |
array | Review decision |
verification_uuid |
string (uuid) | Verification UUID |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
verification |
string (uri) | |
verification_uuid |
string (uuid) | |
country |
string | |
user |
string (uri) | |
user_full_name |
string | |
legal_person_identifier |
string | |
legal_name |
string | |
error_message |
string | |
error_traceback |
string | |
user_justification |
string | User's explanation for why they should be authorized |
validated_by |
string (uri) | |
validated_at |
string (date-time) | |
validation_decision |
any | |
staff_notes |
string | Administrator notes on the review decision |
supporting_documentation |
array of objects | |
supporting_documentation.uuid |
string (uuid) | |
supporting_documentation.file |
string (uri) | Upload supporting documentation. |
supporting_documentation.file_name |
string | |
supporting_documentation.file_size |
integer | |
supporting_documentation.created |
string (date-time) | |
onboarding_metadata |
object (free-form) | Onboarding-specific data like intents, purposes extracted from checklist answers |
user_submitted_customer_data |
object (free-form) | Customer-related data submitted by the user via checklist answers |
created |
string (date-time) | |
modified |
string (date-time) |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
onboarding_justifications_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
verification |
string (uri) | |
verification_uuid |
string (uuid) | |
country |
string | |
user |
string (uri) | |
user_full_name |
string | |
legal_person_identifier |
string | |
legal_name |
string | |
error_message |
string | |
error_traceback |
string | |
user_justification |
string | User's explanation for why they should be authorized |
validated_by |
string (uri) | |
validated_at |
string (date-time) | |
validation_decision |
any | |
staff_notes |
string | Administrator notes on the review decision |
supporting_documentation |
array of objects | |
supporting_documentation.uuid |
string (uuid) | |
supporting_documentation.file |
string (uri) | Upload supporting documentation. |
supporting_documentation.file_name |
string | |
supporting_documentation.file_size |
integer | |
supporting_documentation.created |
string (date-time) | |
onboarding_metadata |
object (free-form) | Onboarding-specific data like intents, purposes extracted from checklist answers |
user_submitted_customer_data |
object (free-form) | Customer-related data submitted by the user via checklist answers |
created |
string (date-time) | |
modified |
string (date-time) |
Create
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
- Model Source:
OnboardingJustificationRequest - API Source:
onboarding_justifications_create
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Field | Type | Required | Description |
|---|---|---|---|
verification |
string (uri) | ✓ | |
user_justification |
string | User's explanation for why they should be authorized |
201 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
verification |
string (uri) | |
verification_uuid |
string (uuid) | |
country |
string | |
user |
string (uri) | |
user_full_name |
string | |
legal_person_identifier |
string | |
legal_name |
string | |
error_message |
string | |
error_traceback |
string | |
user_justification |
string | User's explanation for why they should be authorized |
validated_by |
string (uri) | |
validated_at |
string (date-time) | |
validation_decision |
any | |
staff_notes |
string | Administrator notes on the review decision |
supporting_documentation |
array of objects | |
supporting_documentation.uuid |
string (uuid) | |
supporting_documentation.file |
string (uri) | Upload supporting documentation. |
supporting_documentation.file_name |
string | |
supporting_documentation.file_size |
integer | |
supporting_documentation.created |
string (date-time) | |
onboarding_metadata |
object (free-form) | Onboarding-specific data like intents, purposes extracted from checklist answers |
user_submitted_customer_data |
object (free-form) | Customer-related data submitted by the user via checklist answers |
created |
string (date-time) | |
modified |
string (date-time) |
Create justification for failed verification
Create justification for failed verification.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
- Model Source:
OnboardingJustificationCreateRequest - API Source:
onboarding_justifications_create_justification
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Field | Type | Required | Description |
|---|---|---|---|
verification_uuid |
string (uuid) | ✓ | UUID of the OnboardingVerification to justify |
user_justification |
string | User's explanation for why they should be authorized |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
verification |
string (uri) | |
verification_uuid |
string (uuid) | |
country |
string | |
user |
string (uri) | |
user_full_name |
string | |
legal_person_identifier |
string | |
legal_name |
string | |
error_message |
string | |
error_traceback |
string | |
user_justification |
string | User's explanation for why they should be authorized |
validated_by |
string (uri) | |
validated_at |
string (date-time) | |
validation_decision |
any | |
staff_notes |
string | Administrator notes on the review decision |
supporting_documentation |
array of objects | |
supporting_documentation.uuid |
string (uuid) | |
supporting_documentation.file |
string (uri) | Upload supporting documentation. |
supporting_documentation.file_name |
string | |
supporting_documentation.file_size |
integer | |
supporting_documentation.created |
string (date-time) | |
onboarding_metadata |
object (free-form) | Onboarding-specific data like intents, purposes extracted from checklist answers |
user_submitted_customer_data |
object (free-form) | Customer-related data submitted by the user via checklist answers |
created |
string (date-time) | |
modified |
string (date-time) |
Update
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
OnboardingJustificationRequest - API Source:
onboarding_justifications_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
verification |
string (uri) | ✓ | |
user_justification |
string | User's explanation for why they should be authorized |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
verification |
string (uri) | |
verification_uuid |
string (uuid) | |
country |
string | |
user |
string (uri) | |
user_full_name |
string | |
legal_person_identifier |
string | |
legal_name |
string | |
error_message |
string | |
error_traceback |
string | |
user_justification |
string | User's explanation for why they should be authorized |
validated_by |
string (uri) | |
validated_at |
string (date-time) | |
validation_decision |
any | |
staff_notes |
string | Administrator notes on the review decision |
supporting_documentation |
array of objects | |
supporting_documentation.uuid |
string (uuid) | |
supporting_documentation.file |
string (uri) | Upload supporting documentation. |
supporting_documentation.file_name |
string | |
supporting_documentation.file_size |
integer | |
supporting_documentation.created |
string (date-time) | |
onboarding_metadata |
object (free-form) | Onboarding-specific data like intents, purposes extracted from checklist answers |
user_submitted_customer_data |
object (free-form) | Customer-related data submitted by the user via checklist answers |
created |
string (date-time) | |
modified |
string (date-time) |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedOnboardingJustificationRequest - API Source:
onboarding_justifications_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
verification |
string (uri) | ||
user_justification |
string | User's explanation for why they should be authorized |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
verification |
string (uri) | |
verification_uuid |
string (uuid) | |
country |
string | |
user |
string (uri) | |
user_full_name |
string | |
legal_person_identifier |
string | |
legal_name |
string | |
error_message |
string | |
error_traceback |
string | |
user_justification |
string | User's explanation for why they should be authorized |
validated_by |
string (uri) | |
validated_at |
string (date-time) | |
validation_decision |
any | |
staff_notes |
string | Administrator notes on the review decision |
supporting_documentation |
array of objects | |
supporting_documentation.uuid |
string (uuid) | |
supporting_documentation.file |
string (uri) | Upload supporting documentation. |
supporting_documentation.file_name |
string | |
supporting_documentation.file_size |
integer | |
supporting_documentation.created |
string (date-time) | |
onboarding_metadata |
object (free-form) | Onboarding-specific data like intents, purposes extracted from checklist answers |
user_submitted_customer_data |
object (free-form) | Customer-related data submitted by the user via checklist answers |
created |
string (date-time) | |
modified |
string (date-time) |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
onboarding_justifications_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
Approve justification and mark verification as VERIFIED
Approve justification and mark verification as VERIFIED.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
OnboardingJustificationReviewRequest - API Source:
onboarding_justifications_approve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
staff_notes |
string | Administrator notes about the review decision |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
verification |
string (uri) | |
verification_uuid |
string (uuid) | |
country |
string | |
user |
string (uri) | |
user_full_name |
string | |
legal_person_identifier |
string | |
legal_name |
string | |
error_message |
string | |
error_traceback |
string | |
user_justification |
string | User's explanation for why they should be authorized |
validated_by |
string (uri) | |
validated_at |
string (date-time) | |
validation_decision |
any | |
staff_notes |
string | Administrator notes on the review decision |
supporting_documentation |
array of objects | |
supporting_documentation.uuid |
string (uuid) | |
supporting_documentation.file |
string (uri) | Upload supporting documentation. |
supporting_documentation.file_name |
string | |
supporting_documentation.file_size |
integer | |
supporting_documentation.created |
string (date-time) | |
onboarding_metadata |
object (free-form) | Onboarding-specific data like intents, purposes extracted from checklist answers |
user_submitted_customer_data |
object (free-form) | Customer-related data submitted by the user via checklist answers |
created |
string (date-time) | |
modified |
string (date-time) |
Attach supporting document to justification
Attach supporting document to justification.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
OnboardingJustificationDocumentationRequest - API Source:
onboarding_justifications_attach_document
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
file |
string (binary) | Upload supporting documentation. |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
file |
string (uri) | Upload supporting documentation. |
file_name |
string | |
file_size |
integer | |
created |
string (date-time) |
Reject justification and mark verification as FAILED
Reject justification and mark verification as FAILED.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
OnboardingJustificationReviewRequest - API Source:
onboarding_justifications_reject
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
staff_notes |
string | Administrator notes about the review decision |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
verification |
string (uri) | |
verification_uuid |
string (uuid) | |
country |
string | |
user |
string (uri) | |
user_full_name |
string | |
legal_person_identifier |
string | |
legal_name |
string | |
error_message |
string | |
error_traceback |
string | |
user_justification |
string | User's explanation for why they should be authorized |
validated_by |
string (uri) | |
validated_at |
string (date-time) | |
validation_decision |
any | |
staff_notes |
string | Administrator notes on the review decision |
supporting_documentation |
array of objects | |
supporting_documentation.uuid |
string (uuid) | |
supporting_documentation.file |
string (uri) | Upload supporting documentation. |
supporting_documentation.file_name |
string | |
supporting_documentation.file_size |
integer | |
supporting_documentation.created |
string (date-time) | |
onboarding_metadata |
object (free-form) | Onboarding-specific data like intents, purposes extracted from checklist answers |
user_submitted_customer_data |
object (free-form) | Customer-related data submitted by the user via checklist answers |
created |
string (date-time) | |
modified |
string (date-time) |
Onboarding Question Metadata
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/onboarding-question-metadata/ |
List Onboarding Question Metadata |
| GET | /api/onboarding-question-metadata/{uuid}/ |
Retrieve |
| POST | /api/onboarding-question-metadata/ |
Create |
| PUT | /api/onboarding-question-metadata/{uuid}/ |
Update |
| PATCH | /api/onboarding-question-metadata/{uuid}/ |
Partial Update |
| DELETE | /api/onboarding-question-metadata/{uuid}/ |
Delete |
List Onboarding Question Metadata
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
onboarding_question_metadata_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
checklist_uuid |
string (uuid) | Checklist uuid |
intent_field |
string | |
maps_to_customer_field |
string | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
question_description |
string | |
question_uuid |
string (uuid) |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
checklist_name |
string | |
question |
string (uri) | |
question_uuid |
string (uuid) | |
question_description |
string | |
maps_to_customer_field |
string | Customer model field name to map this answer to (e.g., 'registration_code', 'email', 'vat_code') |
intent_field |
string | Type of intent/purpose field (e.g., 'intent', 'registration_purpose') - stays with verification |
created |
string (date-time) | |
modified |
string (date-time) |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
onboarding_question_metadata_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
checklist_name |
string | |
question |
string (uri) | |
question_uuid |
string (uuid) | |
question_description |
string | |
maps_to_customer_field |
string | Customer model field name to map this answer to (e.g., 'registration_code', 'email', 'vat_code') |
intent_field |
string | Type of intent/purpose field (e.g., 'intent', 'registration_purpose') - stays with verification |
created |
string (date-time) | |
modified |
string (date-time) |
Create
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
- Model Source:
OnboardingQuestionMetadataRequest - API Source:
onboarding_question_metadata_create
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Field | Type | Required | Description |
|---|---|---|---|
question |
string (uri) | ✓ | |
maps_to_customer_field |
string | Customer model field name to map this answer to (e.g., 'registration_code', 'email', 'vat_code') | |
intent_field |
string | Type of intent/purpose field (e.g., 'intent', 'registration_purpose') - stays with verification |
201 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
checklist_name |
string | |
question |
string (uri) | |
question_uuid |
string (uuid) | |
question_description |
string | |
maps_to_customer_field |
string | Customer model field name to map this answer to (e.g., 'registration_code', 'email', 'vat_code') |
intent_field |
string | Type of intent/purpose field (e.g., 'intent', 'registration_purpose') - stays with verification |
created |
string (date-time) | |
modified |
string (date-time) |
Update
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
OnboardingQuestionMetadataRequest - API Source:
onboarding_question_metadata_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
question |
string (uri) | ✓ | |
maps_to_customer_field |
string | Customer model field name to map this answer to (e.g., 'registration_code', 'email', 'vat_code') | |
intent_field |
string | Type of intent/purpose field (e.g., 'intent', 'registration_purpose') - stays with verification |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
checklist_name |
string | |
question |
string (uri) | |
question_uuid |
string (uuid) | |
question_description |
string | |
maps_to_customer_field |
string | Customer model field name to map this answer to (e.g., 'registration_code', 'email', 'vat_code') |
intent_field |
string | Type of intent/purpose field (e.g., 'intent', 'registration_purpose') - stays with verification |
created |
string (date-time) | |
modified |
string (date-time) |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedOnboardingQuestionMetadataRequest - API Source:
onboarding_question_metadata_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
question |
string (uri) | ||
maps_to_customer_field |
string | Customer model field name to map this answer to (e.g., 'registration_code', 'email', 'vat_code') | |
intent_field |
string | Type of intent/purpose field (e.g., 'intent', 'registration_purpose') - stays with verification |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
checklist_name |
string | |
question |
string (uri) | |
question_uuid |
string (uuid) | |
question_description |
string | |
maps_to_customer_field |
string | Customer model field name to map this answer to (e.g., 'registration_code', 'email', 'vat_code') |
intent_field |
string | Type of intent/purpose field (e.g., 'intent', 'registration_purpose') - stays with verification |
created |
string (date-time) | |
modified |
string (date-time) |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
onboarding_question_metadata_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Onboarding Verifications
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/onboarding-verifications/ |
List Onboarding Verifications |
| GET | /api/onboarding-verifications/{uuid}/ |
Retrieve |
| POST | /api/onboarding-verifications/ |
Create |
| POST | /api/onboarding-verifications/{uuid}/create_customer/ |
Create customer from successful verification |
| PUT | /api/onboarding-verifications/{uuid}/ |
Update |
| PATCH | /api/onboarding-verifications/{uuid}/ |
Partial Update |
| DELETE | /api/onboarding-verifications/{uuid}/ |
Delete |
| Other Actions | ||
| GET | /api/onboarding-verifications/available_checklists/ |
Available checklists |
| GET | /api/onboarding-verifications/{uuid}/checklist/ |
Checklist |
| GET | /api/onboarding-verifications/checklist-template/ |
Get checklist template for creating new objects |
| GET | /api/onboarding-verifications/{uuid}/completion_status/ |
Completion status |
| POST | /api/onboarding-verifications/{uuid}/run_validation/ |
Run validation |
| POST | /api/onboarding-verifications/start_verification/ |
Start verification |
| POST | /api/onboarding-verifications/{uuid}/submit_answers/ |
Submit answers |
Core CRUD
List Onboarding Verifications
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
OnboardingVerificationOEnum - Model Source:
OnboardingVerificationStatusEnum1 - Model Source:
OnboardingVerificationValidationMethodEnum - API Source:
onboarding_verifications_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
country |
string | |
legal_name |
string | |
legal_person_identifier |
string | |
o |
array | Ordering |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
query |
string | Filter by legal name, legal person identifier |
status |
array | Verification status |
user_uuid |
string (uuid) | User UUID |
validation_method |
array | Validation method |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
user |
string (uri) | User requesting company onboarding |
user_full_name |
string | |
country |
string | ISO country code (e.g., 'EE', 'AT') for context. Can be inferred from validation_method. |
legal_person_identifier |
string | Official company registration code (required for automatic validation) |
legal_name |
string | Company name(optional, for reference) |
status |
any | |
justifications |
array of objects | |
justifications.uuid |
string (uuid) | |
justifications.verification |
string (uri) | |
justifications.verification_uuid |
string (uuid) | |
justifications.country |
string | |
justifications.user |
string (uri) | |
justifications.user_full_name |
string | |
justifications.legal_person_identifier |
string | |
justifications.legal_name |
string | |
justifications.error_message |
string | |
justifications.error_traceback |
string | |
justifications.user_justification |
string | User's explanation for why they should be authorized |
justifications.validated_by |
string (uri) | |
justifications.validated_at |
string (date-time) | |
justifications.validation_decision |
any | |
justifications.staff_notes |
string | Administrator notes on the review decision |
justifications.supporting_documentation |
array of objects | |
justifications.supporting_documentation.uuid |
string (uuid) | |
justifications.supporting_documentation.file |
string (uri) | Upload supporting documentation. |
justifications.supporting_documentation.file_name |
string | |
justifications.supporting_documentation.file_size |
integer | |
justifications.supporting_documentation.created |
string (date-time) | |
justifications.onboarding_metadata |
object (free-form) | Onboarding-specific data like intents, purposes extracted from checklist answers |
justifications.user_submitted_customer_data |
object (free-form) | Customer-related data submitted by the user via checklist answers |
justifications.created |
string (date-time) | |
justifications.modified |
string (date-time) | |
validation_method |
any | Method used for validation |
verified_user_roles |
any | Roles the user has in the company |
verified_company_data |
any | Company information retrieved during validation |
raw_response |
any | Raw API response for debugging and auditing |
error_traceback |
string | |
error_message |
string | |
validated_at |
string (date-time) | When validation was completed |
expires_at |
string (date-time) | When this verification expires |
customer |
string (uri) | Customer created after successful validation |
onboarding_metadata |
object (free-form) | Onboarding-specific data like intents, purposes extracted from checklist answers |
user_submitted_customer_data |
object (free-form) | Get customer data submitted by the user during onboarding. |
can_customer_be_created |
boolean | Boolean indicating if a customer can be created from this verification |
customer_creation_error_message |
string | Reason why customer cannot be created (null if can be created) |
created |
string (date-time) | |
modified |
string (date-time) |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
onboarding_verifications_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
user |
string (uri) | User requesting company onboarding |
user_full_name |
string | |
country |
string | ISO country code (e.g., 'EE', 'AT') for context. Can be inferred from validation_method. |
legal_person_identifier |
string | Official company registration code (required for automatic validation) |
legal_name |
string | Company name(optional, for reference) |
status |
any | |
justifications |
array of objects | |
justifications.uuid |
string (uuid) | |
justifications.verification |
string (uri) | |
justifications.verification_uuid |
string (uuid) | |
justifications.country |
string | |
justifications.user |
string (uri) | |
justifications.user_full_name |
string | |
justifications.legal_person_identifier |
string | |
justifications.legal_name |
string | |
justifications.error_message |
string | |
justifications.error_traceback |
string | |
justifications.user_justification |
string | User's explanation for why they should be authorized |
justifications.validated_by |
string (uri) | |
justifications.validated_at |
string (date-time) | |
justifications.validation_decision |
any | |
justifications.staff_notes |
string | Administrator notes on the review decision |
justifications.supporting_documentation |
array of objects | |
justifications.supporting_documentation.uuid |
string (uuid) | |
justifications.supporting_documentation.file |
string (uri) | Upload supporting documentation. |
justifications.supporting_documentation.file_name |
string | |
justifications.supporting_documentation.file_size |
integer | |
justifications.supporting_documentation.created |
string (date-time) | |
justifications.onboarding_metadata |
object (free-form) | Onboarding-specific data like intents, purposes extracted from checklist answers |
justifications.user_submitted_customer_data |
object (free-form) | Customer-related data submitted by the user via checklist answers |
justifications.created |
string (date-time) | |
justifications.modified |
string (date-time) | |
validation_method |
any | Method used for validation |
verified_user_roles |
any | Roles the user has in the company |
verified_company_data |
any | Company information retrieved during validation |
raw_response |
any | Raw API response for debugging and auditing |
error_traceback |
string | |
error_message |
string | |
validated_at |
string (date-time) | When validation was completed |
expires_at |
string (date-time) | When this verification expires |
customer |
string (uri) | Customer created after successful validation |
onboarding_metadata |
object (free-form) | Onboarding-specific data like intents, purposes extracted from checklist answers |
user_submitted_customer_data |
object (free-form) | Get customer data submitted by the user during onboarding. |
can_customer_be_created |
boolean | Boolean indicating if a customer can be created from this verification |
customer_creation_error_message |
string | Reason why customer cannot be created (null if can be created) |
created |
string (date-time) | |
modified |
string (date-time) |
Create
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
- Model Source:
OnboardingVerificationRequest - API Source:
onboarding_verifications_create
1 2 3 4 5 6 7 8 9 10 | |
| Field | Type | Required | Description |
|---|---|---|---|
country |
string | ISO country code (e.g., 'EE', 'AT') for context. Can be inferred from validation_method. | |
legal_person_identifier |
string | Official company registration code (required for automatic validation) | |
legal_name |
string | Company name(optional, for reference) | |
expires_at |
string (date-time) | When this verification expires |
201 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
user |
string (uri) | User requesting company onboarding |
user_full_name |
string | |
country |
string | ISO country code (e.g., 'EE', 'AT') for context. Can be inferred from validation_method. |
legal_person_identifier |
string | Official company registration code (required for automatic validation) |
legal_name |
string | Company name(optional, for reference) |
status |
any | |
justifications |
array of objects | |
justifications.uuid |
string (uuid) | |
justifications.verification |
string (uri) | |
justifications.verification_uuid |
string (uuid) | |
justifications.country |
string | |
justifications.user |
string (uri) | |
justifications.user_full_name |
string | |
justifications.legal_person_identifier |
string | |
justifications.legal_name |
string | |
justifications.error_message |
string | |
justifications.error_traceback |
string | |
justifications.user_justification |
string | User's explanation for why they should be authorized |
justifications.validated_by |
string (uri) | |
justifications.validated_at |
string (date-time) | |
justifications.validation_decision |
any | |
justifications.staff_notes |
string | Administrator notes on the review decision |
justifications.supporting_documentation |
array of objects | |
justifications.supporting_documentation.uuid |
string (uuid) | |
justifications.supporting_documentation.file |
string (uri) | Upload supporting documentation. |
justifications.supporting_documentation.file_name |
string | |
justifications.supporting_documentation.file_size |
integer | |
justifications.supporting_documentation.created |
string (date-time) | |
justifications.onboarding_metadata |
object (free-form) | Onboarding-specific data like intents, purposes extracted from checklist answers |
justifications.user_submitted_customer_data |
object (free-form) | Customer-related data submitted by the user via checklist answers |
justifications.created |
string (date-time) | |
justifications.modified |
string (date-time) | |
validation_method |
any | Method used for validation |
verified_user_roles |
any | Roles the user has in the company |
verified_company_data |
any | Company information retrieved during validation |
raw_response |
any | Raw API response for debugging and auditing |
error_traceback |
string | |
error_message |
string | |
validated_at |
string (date-time) | When validation was completed |
expires_at |
string (date-time) | When this verification expires |
customer |
string (uri) | Customer created after successful validation |
onboarding_metadata |
object (free-form) | Onboarding-specific data like intents, purposes extracted from checklist answers |
user_submitted_customer_data |
object (free-form) | Get customer data submitted by the user during onboarding. |
can_customer_be_created |
boolean | Boolean indicating if a customer can be created from this verification |
customer_creation_error_message |
string | Reason why customer cannot be created (null if can be created) |
created |
string (date-time) | |
modified |
string (date-time) |
Create customer from successful verification
Create customer from successful verification.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
onboarding_verifications_create_customer
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
201 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
organization_groups |
array of objects | Organization groups this customer belongs to |
organization_groups.uuid |
string (uuid) | |
organization_groups.url |
string (uri) | |
organization_groups.name |
string | |
organization_groups.parent_uuid |
string (uuid) | UUID of the parent organization group |
organization_groups.parent_name |
string | Name of the parent organization group |
organization_groups.parent |
string (uri) | |
organization_groups.customers_count |
integer | Number of customers in this organization group |
display_name |
string | Display name of the organization (includes native name if available) |
backend_id |
string | Organization identifier in another application. |
image |
string (uri) | |
blocked |
boolean | |
archived |
boolean | |
display_billing_info_in_projects |
boolean | |
default_tax_percent |
string (decimal) | |
accounting_start_date |
string (date-time) | |
projects_count |
integer | Number of projects in this organization |
users_count |
integer | Number of users with access to this organization |
sponsor_number |
integer | External ID of the sponsor covering the costs |
country_name |
string | Human-readable country name |
max_service_accounts |
integer | Maximum number of service accounts allowed |
project_metadata_checklist |
string (uuid) | Checklist to be used for project metadata validation in this organization |
grace_period_days |
integer | Number of extra days after project end date before resources are terminated |
user_email_patterns |
any | |
user_affiliations |
any | |
user_identity_sources |
any | List of allowed identity sources (identity providers). |
name |
string | |
slug |
string | URL-friendly identifier. Only editable by staff users. |
native_name |
string | |
abbreviation |
string | |
description |
string | |
contact_details |
string | |
agreement_number |
string | |
email |
string (email) | |
phone_number |
string | |
access_subnets |
string | Enter a comma separated list of IPv4 or IPv6 CIDR addresses from where connection to self-service is allowed. |
registration_code |
string | |
homepage |
string (uri) | |
domain |
string | |
vat_code |
string | VAT number |
postal |
string | |
address |
string | |
bank_name |
string | |
latitude |
number (double) | |
longitude |
number (double) | |
bank_account |
string | |
country |
any | Country code (ISO 3166-1 alpha-2) |
notification_emails |
string | Comma-separated list of notification email addresses |
payment_profiles |
array of objects | |
payment_profiles.uuid |
string (uuid) | |
payment_profiles.url |
string (uri) | |
payment_profiles.name |
string | |
payment_profiles.organization_uuid |
string (uuid) | |
payment_profiles.organization |
string (uri) | |
payment_profiles.attributes |
object | |
payment_profiles.attributes.end_date |
string | |
payment_profiles.attributes.agreement_number |
string | |
payment_profiles.attributes.contract_sum |
integer | |
payment_profiles.payment_type |
string | Enum: fixed_price, invoices, payment_gw_monthly |
payment_profiles.payment_type_display |
string | |
payment_profiles.is_active |
boolean | |
customer_credit |
number (double) | |
customer_unallocated_credit |
number (double) | |
is_service_provider |
boolean | |
service_provider |
string (uri) | |
service_provider_uuid |
string (uuid) | |
call_managing_organization_uuid |
string | |
billing_price_estimate |
any |
Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
OnboardingVerificationRequest - API Source:
onboarding_verifications_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
country |
string | ISO country code (e.g., 'EE', 'AT') for context. Can be inferred from validation_method. | |
legal_person_identifier |
string | Official company registration code (required for automatic validation) | |
legal_name |
string | Company name(optional, for reference) | |
expires_at |
string (date-time) | When this verification expires |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
user |
string (uri) | User requesting company onboarding |
user_full_name |
string | |
country |
string | ISO country code (e.g., 'EE', 'AT') for context. Can be inferred from validation_method. |
legal_person_identifier |
string | Official company registration code (required for automatic validation) |
legal_name |
string | Company name(optional, for reference) |
status |
any | |
justifications |
array of objects | |
justifications.uuid |
string (uuid) | |
justifications.verification |
string (uri) | |
justifications.verification_uuid |
string (uuid) | |
justifications.country |
string | |
justifications.user |
string (uri) | |
justifications.user_full_name |
string | |
justifications.legal_person_identifier |
string | |
justifications.legal_name |
string | |
justifications.error_message |
string | |
justifications.error_traceback |
string | |
justifications.user_justification |
string | User's explanation for why they should be authorized |
justifications.validated_by |
string (uri) | |
justifications.validated_at |
string (date-time) | |
justifications.validation_decision |
any | |
justifications.staff_notes |
string | Administrator notes on the review decision |
justifications.supporting_documentation |
array of objects | |
justifications.supporting_documentation.uuid |
string (uuid) | |
justifications.supporting_documentation.file |
string (uri) | Upload supporting documentation. |
justifications.supporting_documentation.file_name |
string | |
justifications.supporting_documentation.file_size |
integer | |
justifications.supporting_documentation.created |
string (date-time) | |
justifications.onboarding_metadata |
object (free-form) | Onboarding-specific data like intents, purposes extracted from checklist answers |
justifications.user_submitted_customer_data |
object (free-form) | Customer-related data submitted by the user via checklist answers |
justifications.created |
string (date-time) | |
justifications.modified |
string (date-time) | |
validation_method |
any | Method used for validation |
verified_user_roles |
any | Roles the user has in the company |
verified_company_data |
any | Company information retrieved during validation |
raw_response |
any | Raw API response for debugging and auditing |
error_traceback |
string | |
error_message |
string | |
validated_at |
string (date-time) | When validation was completed |
expires_at |
string (date-time) | When this verification expires |
customer |
string (uri) | Customer created after successful validation |
onboarding_metadata |
object (free-form) | Onboarding-specific data like intents, purposes extracted from checklist answers |
user_submitted_customer_data |
object (free-form) | Get customer data submitted by the user during onboarding. |
can_customer_be_created |
boolean | Boolean indicating if a customer can be created from this verification |
customer_creation_error_message |
string | Reason why customer cannot be created (null if can be created) |
created |
string (date-time) | |
modified |
string (date-time) |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedOnboardingVerificationRequest - API Source:
onboarding_verifications_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
country |
string | ISO country code (e.g., 'EE', 'AT') for context. Can be inferred from validation_method. | |
legal_person_identifier |
string | Official company registration code (required for automatic validation) | |
legal_name |
string | Company name(optional, for reference) | |
expires_at |
string (date-time) | When this verification expires |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
user |
string (uri) | User requesting company onboarding |
user_full_name |
string | |
country |
string | ISO country code (e.g., 'EE', 'AT') for context. Can be inferred from validation_method. |
legal_person_identifier |
string | Official company registration code (required for automatic validation) |
legal_name |
string | Company name(optional, for reference) |
status |
any | |
justifications |
array of objects | |
justifications.uuid |
string (uuid) | |
justifications.verification |
string (uri) | |
justifications.verification_uuid |
string (uuid) | |
justifications.country |
string | |
justifications.user |
string (uri) | |
justifications.user_full_name |
string | |
justifications.legal_person_identifier |
string | |
justifications.legal_name |
string | |
justifications.error_message |
string | |
justifications.error_traceback |
string | |
justifications.user_justification |
string | User's explanation for why they should be authorized |
justifications.validated_by |
string (uri) | |
justifications.validated_at |
string (date-time) | |
justifications.validation_decision |
any | |
justifications.staff_notes |
string | Administrator notes on the review decision |
justifications.supporting_documentation |
array of objects | |
justifications.supporting_documentation.uuid |
string (uuid) | |
justifications.supporting_documentation.file |
string (uri) | Upload supporting documentation. |
justifications.supporting_documentation.file_name |
string | |
justifications.supporting_documentation.file_size |
integer | |
justifications.supporting_documentation.created |
string (date-time) | |
justifications.onboarding_metadata |
object (free-form) | Onboarding-specific data like intents, purposes extracted from checklist answers |
justifications.user_submitted_customer_data |
object (free-form) | Customer-related data submitted by the user via checklist answers |
justifications.created |
string (date-time) | |
justifications.modified |
string (date-time) | |
validation_method |
any | Method used for validation |
verified_user_roles |
any | Roles the user has in the company |
verified_company_data |
any | Company information retrieved during validation |
raw_response |
any | Raw API response for debugging and auditing |
error_traceback |
string | |
error_message |
string | |
validated_at |
string (date-time) | When validation was completed |
expires_at |
string (date-time) | When this verification expires |
customer |
string (uri) | Customer created after successful validation |
onboarding_metadata |
object (free-form) | Onboarding-specific data like intents, purposes extracted from checklist answers |
user_submitted_customer_data |
object (free-form) | Get customer data submitted by the user during onboarding. |
can_customer_be_created |
boolean | Boolean indicating if a customer can be created from this verification |
customer_creation_error_message |
string | Reason why customer cannot be created (null if can be created) |
created |
string (date-time) | |
modified |
string (date-time) |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
onboarding_verifications_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
Available checklists
Get available onboarding checklists (customer and intent) for preview. This endpoint allows users to see checklist questions before creating a verification. Supports checklist_type parameter to filter by customer or intent checklists. Includes questions with onboarding metadata (field mappings).
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- Model Source:
AvailableChecklistsResponseChecklistTypeEnum - API Source:
onboarding_verifications_available_checklists_retrieve
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
checklist_type |
string | Type of checklist to retrieve (customer, intent, or all). Defaults to all. Enum: customer, intent, all |
200 -
| Field | Type |
|---|---|
customer_checklist |
object (free-form) |
intent_checklist |
object (free-form) |
Checklist
Get checklist with questions and existing answers. Supports both customer and intent checklists via checklist_type parameter.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
ChecklistResponseChecklistTypeEnum - API Source:
onboarding_verifications_checklist_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
checklist_type |
string | Type of checklist to retrieve (customer or intent). Defaults to intent. Enum: customer, intent |
include_all |
boolean | If true, returns all questions including hidden ones. Default: False |
200 -
| Field | Type | Description |
|---|---|---|
checklist |
object (free-form) | |
completion |
object | |
completion.uuid |
string (uuid) | |
completion.is_completed |
boolean | Whether all required questions have been answered |
completion.completion_percentage |
number (double) | |
completion.unanswered_required_questions |
array of anys | |
completion.checklist_name |
string | |
completion.checklist_description |
string | |
completion.created |
string (date-time) | |
completion.modified |
string (date-time) | |
questions |
array of objects | |
questions.uuid |
string (uuid) | |
questions.description |
string | |
questions.user_guidance |
string | |
questions.question_type |
any | Type of question and expected answer format |
questions.required |
boolean | |
questions.order |
integer | |
questions.existing_answer |
object (free-form) | |
questions.question_options |
array of anys | |
questions.min_value |
string (decimal) | Minimum value allowed for NUMBER, YEAR, and RATING type questions |
questions.max_value |
string (decimal) | Maximum value allowed for NUMBER, YEAR, and RATING type questions |
questions.allowed_file_types |
any | List of allowed file extensions (e.g., ['.pdf', '.doc', '.docx']). If empty, all file types are allowed. |
questions.allowed_mime_types |
any | List of allowed MIME types (e.g., ['application/pdf', 'application/msword']). If empty, MIME type validation is not enforced. When both extensions and MIME types are specified, files must match both criteria for security. |
questions.max_file_size_mb |
integer | Maximum file size in megabytes. If not set, no size limit is enforced. |
questions.max_files_count |
integer | Maximum number of files allowed for MULTIPLE_FILES type questions. If not set, no count limit is enforced. |
questions.dependencies_info |
object (free-form) |
Get checklist template for creating new objects
Get checklist template for creating new objects.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required | Description |
|---|---|---|---|
parent_uuid |
string (uuid) | ✓ | UUID of the parent object (e.g., customer UUID for new projects) |
200 -
| Field | Type | Description |
|---|---|---|
checklist |
object (free-form) | |
questions |
array of objects | |
questions.uuid |
string (uuid) | |
questions.required |
boolean | |
questions.description |
string | |
questions.user_guidance |
string | Additional guidance text visible to users when answering and reviewing |
questions.question_options |
array of objects | |
questions.question_options.uuid |
string (uuid) | |
questions.question_options.label |
string | |
questions.question_options.order |
integer | |
questions.question_type |
any | Type of question and expected answer format |
questions.order |
integer | |
questions.min_value |
string (decimal) | Minimum value allowed for NUMBER, YEAR, and RATING type questions |
questions.max_value |
string (decimal) | Maximum value allowed for NUMBER, YEAR, and RATING type questions |
questions.allowed_file_types |
any | List of allowed file extensions (e.g., ['.pdf', '.doc', '.docx']). If empty, all file types are allowed. |
questions.allowed_mime_types |
any | List of allowed MIME types (e.g., ['application/pdf', 'application/msword']). If empty, MIME type validation is not enforced. When both extensions and MIME types are specified, files must match both criteria for security. |
questions.max_file_size_mb |
integer | Maximum file size in megabytes. If not set, no size limit is enforced. |
questions.max_files_count |
integer | Maximum number of files allowed for MULTIPLE_FILES type questions. If not set, no count limit is enforced. |
questions.operator |
any | |
questions.review_answer_value |
any | Answer value that trigger review. |
questions.always_requires_review |
boolean | This question always requires review regardless of answer |
questions.guidance_answer_value |
any | Answer value that triggers display of user guidance. |
questions.guidance_operator |
any | Operator to use when comparing answer with guidance_answer_value |
questions.always_show_guidance |
boolean | Show user guidance always, regardless of answer. If False, guidance is conditional on answer matching guidance_answer_value with guidance_operator |
questions.dependency_logic_operator |
any | Defines how multiple dependencies are evaluated. AND: All dependencies must be satisfied. OR: At least one dependency must be satisfied. |
initial_visible_questions |
array of objects | |
initial_visible_questions.uuid |
string (uuid) | |
initial_visible_questions.required |
boolean | |
initial_visible_questions.description |
string | |
initial_visible_questions.user_guidance |
string | Additional guidance text visible to users when answering and reviewing |
initial_visible_questions.question_options |
array of objects | |
initial_visible_questions.question_options.uuid |
string (uuid) | |
initial_visible_questions.question_options.label |
string | |
initial_visible_questions.question_options.order |
integer | |
initial_visible_questions.question_type |
any | Type of question and expected answer format |
initial_visible_questions.order |
integer | |
initial_visible_questions.min_value |
string (decimal) | Minimum value allowed for NUMBER, YEAR, and RATING type questions |
initial_visible_questions.max_value |
string (decimal) | Maximum value allowed for NUMBER, YEAR, and RATING type questions |
initial_visible_questions.allowed_file_types |
any | List of allowed file extensions (e.g., ['.pdf', '.doc', '.docx']). If empty, all file types are allowed. |
initial_visible_questions.allowed_mime_types |
any | List of allowed MIME types (e.g., ['application/pdf', 'application/msword']). If empty, MIME type validation is not enforced. When both extensions and MIME types are specified, files must match both criteria for security. |
initial_visible_questions.max_file_size_mb |
integer | Maximum file size in megabytes. If not set, no size limit is enforced. |
initial_visible_questions.max_files_count |
integer | Maximum number of files allowed for MULTIPLE_FILES type questions. If not set, no count limit is enforced. |
initial_visible_questions.operator |
any | |
initial_visible_questions.review_answer_value |
any | Answer value that trigger review. |
initial_visible_questions.always_requires_review |
boolean | This question always requires review regardless of answer |
initial_visible_questions.guidance_answer_value |
any | Answer value that triggers display of user guidance. |
initial_visible_questions.guidance_operator |
any | Operator to use when comparing answer with guidance_answer_value |
initial_visible_questions.always_show_guidance |
boolean | Show user guidance always, regardless of answer. If False, guidance is conditional on answer matching guidance_answer_value with guidance_operator |
initial_visible_questions.dependency_logic_operator |
any | Defines how multiple dependencies are evaluated. AND: All dependencies must be satisfied. OR: At least one dependency must be satisfied. |
400 -
404 -
Completion status
Get checklist completion status. Supports both customer and intent checklists via checklist_type parameter.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
ChecklistResponseChecklistTypeEnum - API Source:
onboarding_verifications_completion_status_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
checklist_type |
string | Type of checklist to retrieve (customer or intent). Defaults to intent. Enum: customer, intent |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
is_completed |
boolean | Whether all required questions have been answered |
completion_percentage |
number (double) | |
unanswered_required_questions |
array of anys | |
checklist_name |
string | |
checklist_description |
string | |
created |
string (date-time) | |
modified |
string (date-time) |
Run validation
Run automatic validation using the required fields provided during verification creation. Checklist answers (if any) are only used for supplemental customer/intent data.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
OnboardingRunValidationRequestRequest - API Source:
onboarding_verifications_run_validation
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
civil_number |
string | Personal identifier (temporary workaround for Estonian civil_number) | |
first_name |
string | User's first name (temporary workaround for Austrian validation) | |
last_name |
string | User's last name (temporary workaround for Austrian validation) | |
birth_date |
string (date) | User's birth date (temporary workaround for Austrian validation) |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
user |
string (uri) | User requesting company onboarding |
user_full_name |
string | |
country |
string | ISO country code (e.g., 'EE', 'AT') for context. Can be inferred from validation_method. |
legal_person_identifier |
string | Official company registration code (required for automatic validation) |
legal_name |
string | Company name(optional, for reference) |
status |
any | |
justifications |
array of objects | |
justifications.uuid |
string (uuid) | |
justifications.verification |
string (uri) | |
justifications.verification_uuid |
string (uuid) | |
justifications.country |
string | |
justifications.user |
string (uri) | |
justifications.user_full_name |
string | |
justifications.legal_person_identifier |
string | |
justifications.legal_name |
string | |
justifications.error_message |
string | |
justifications.error_traceback |
string | |
justifications.user_justification |
string | User's explanation for why they should be authorized |
justifications.validated_by |
string (uri) | |
justifications.validated_at |
string (date-time) | |
justifications.validation_decision |
any | |
justifications.staff_notes |
string | Administrator notes on the review decision |
justifications.supporting_documentation |
array of objects | |
justifications.supporting_documentation.uuid |
string (uuid) | |
justifications.supporting_documentation.file |
string (uri) | Upload supporting documentation. |
justifications.supporting_documentation.file_name |
string | |
justifications.supporting_documentation.file_size |
integer | |
justifications.supporting_documentation.created |
string (date-time) | |
justifications.onboarding_metadata |
object (free-form) | Onboarding-specific data like intents, purposes extracted from checklist answers |
justifications.user_submitted_customer_data |
object (free-form) | Customer-related data submitted by the user via checklist answers |
justifications.created |
string (date-time) | |
justifications.modified |
string (date-time) | |
validation_method |
any | Method used for validation |
verified_user_roles |
any | Roles the user has in the company |
verified_company_data |
any | Company information retrieved during validation |
raw_response |
any | Raw API response for debugging and auditing |
error_traceback |
string | |
error_message |
string | |
validated_at |
string (date-time) | When validation was completed |
expires_at |
string (date-time) | When this verification expires |
customer |
string (uri) | Customer created after successful validation |
onboarding_metadata |
object (free-form) | Onboarding-specific data like intents, purposes extracted from checklist answers |
user_submitted_customer_data |
object (free-form) | Get customer data submitted by the user during onboarding. |
can_customer_be_created |
boolean | Boolean indicating if a customer can be created from this verification |
customer_creation_error_message |
string | Reason why customer cannot be created (null if can be created) |
created |
string (date-time) | |
modified |
string (date-time) |
Start verification
Start company validation process by creating a verification record. User selects validation_method (e.g., 'ariregister', 'wirtschaftscompass'). Checklists are used for intent and customer data collection. Then call run_validation to perform automatic validation or create manual justification.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
- Model Source:
OnboardingCompanyValidationRequestRequest - API Source:
onboarding_verifications_start_verification
1 2 3 4 5 6 7 8 9 10 | |
| Field | Type | Required | Description |
|---|---|---|---|
validation_method |
any | Automatic validation method (e.g., 'ariregister', 'wirtschaftscompass', 'bolagsverket'). Leave empty for manual validation. | |
country |
string | ISO country code (e.g., 'EE', 'AT') - optional, for display context | |
legal_person_identifier |
string | Official company registration code | |
legal_name |
string | Company name (optional) |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
user |
string (uri) | User requesting company onboarding |
user_full_name |
string | |
country |
string | ISO country code (e.g., 'EE', 'AT') for context. Can be inferred from validation_method. |
legal_person_identifier |
string | Official company registration code (required for automatic validation) |
legal_name |
string | Company name(optional, for reference) |
status |
any | |
justifications |
array of objects | |
justifications.uuid |
string (uuid) | |
justifications.verification |
string (uri) | |
justifications.verification_uuid |
string (uuid) | |
justifications.country |
string | |
justifications.user |
string (uri) | |
justifications.user_full_name |
string | |
justifications.legal_person_identifier |
string | |
justifications.legal_name |
string | |
justifications.error_message |
string | |
justifications.error_traceback |
string | |
justifications.user_justification |
string | User's explanation for why they should be authorized |
justifications.validated_by |
string (uri) | |
justifications.validated_at |
string (date-time) | |
justifications.validation_decision |
any | |
justifications.staff_notes |
string | Administrator notes on the review decision |
justifications.supporting_documentation |
array of objects | |
justifications.supporting_documentation.uuid |
string (uuid) | |
justifications.supporting_documentation.file |
string (uri) | Upload supporting documentation. |
justifications.supporting_documentation.file_name |
string | |
justifications.supporting_documentation.file_size |
integer | |
justifications.supporting_documentation.created |
string (date-time) | |
justifications.onboarding_metadata |
object (free-form) | Onboarding-specific data like intents, purposes extracted from checklist answers |
justifications.user_submitted_customer_data |
object (free-form) | Customer-related data submitted by the user via checklist answers |
justifications.created |
string (date-time) | |
justifications.modified |
string (date-time) | |
validation_method |
any | Method used for validation |
verified_user_roles |
any | Roles the user has in the company |
verified_company_data |
any | Company information retrieved during validation |
raw_response |
any | Raw API response for debugging and auditing |
error_traceback |
string | |
error_message |
string | |
validated_at |
string (date-time) | When validation was completed |
expires_at |
string (date-time) | When this verification expires |
customer |
string (uri) | Customer created after successful validation |
onboarding_metadata |
object (free-form) | Onboarding-specific data like intents, purposes extracted from checklist answers |
user_submitted_customer_data |
object (free-form) | Get customer data submitted by the user during onboarding. |
can_customer_be_created |
boolean | Boolean indicating if a customer can be created from this verification |
customer_creation_error_message |
string | Reason why customer cannot be created (null if can be created) |
created |
string (date-time) | |
modified |
string (date-time) |
Submit answers
Submit answers to checklist questions. Automatically detects which checklist (customer or intent) each question belongs to.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
onboarding_verifications_submit_answers
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
The request body is an array of objects, where each object has the following structure:
| Field | Type | Required |
|---|---|---|
question_uuid |
string (uuid) | ✓ |
answer_data |
any | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
user |
string (uri) | User requesting company onboarding |
user_full_name |
string | |
country |
string | ISO country code (e.g., 'EE', 'AT') for context. Can be inferred from validation_method. |
legal_person_identifier |
string | Official company registration code (required for automatic validation) |
legal_name |
string | Company name(optional, for reference) |
status |
any | |
justifications |
array of objects | |
justifications.uuid |
string (uuid) | |
justifications.verification |
string (uri) | |
justifications.verification_uuid |
string (uuid) | |
justifications.country |
string | |
justifications.user |
string (uri) | |
justifications.user_full_name |
string | |
justifications.legal_person_identifier |
string | |
justifications.legal_name |
string | |
justifications.error_message |
string | |
justifications.error_traceback |
string | |
justifications.user_justification |
string | User's explanation for why they should be authorized |
justifications.validated_by |
string (uri) | |
justifications.validated_at |
string (date-time) | |
justifications.validation_decision |
any | |
justifications.staff_notes |
string | Administrator notes on the review decision |
justifications.supporting_documentation |
array of objects | |
justifications.supporting_documentation.uuid |
string (uuid) | |
justifications.supporting_documentation.file |
string (uri) | Upload supporting documentation. |
justifications.supporting_documentation.file_name |
string | |
justifications.supporting_documentation.file_size |
integer | |
justifications.supporting_documentation.created |
string (date-time) | |
justifications.onboarding_metadata |
object (free-form) | Onboarding-specific data like intents, purposes extracted from checklist answers |
justifications.user_submitted_customer_data |
object (free-form) | Customer-related data submitted by the user via checklist answers |
justifications.created |
string (date-time) | |
justifications.modified |
string (date-time) | |
validation_method |
any | Method used for validation |
verified_user_roles |
any | Roles the user has in the company |
verified_company_data |
any | Company information retrieved during validation |
raw_response |
any | Raw API response for debugging and auditing |
error_traceback |
string | |
error_message |
string | |
validated_at |
string (date-time) | When validation was completed |
expires_at |
string (date-time) | When this verification expires |
customer |
string (uri) | Customer created after successful validation |
onboarding_metadata |
object (free-form) | Onboarding-specific data like intents, purposes extracted from checklist answers |
user_submitted_customer_data |
object (free-form) | Get customer data submitted by the user during onboarding. |
can_customer_be_created |
boolean | Boolean indicating if a customer can be created from this verification |
customer_creation_error_message |
string | Reason why customer cannot be created (null if can be created) |
created |
string (date-time) | |
modified |
string (date-time) |
Onboarding
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/onboarding/person-identifier-fields/ |
Person identifier fields |
| GET | /api/onboarding/supported-countries/ |
Return list of supported countries for validation |
Person identifier fields
Return person identifier field specification for a specific validation method. The validation_method parameter should match one of the available methods (e.g., 'ariregister', 'wirtschaftscompass', 'bolagsverket', 'breg').
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
ValidationMethodEnum - API Source:
onboarding_person_identifier_fields_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required | Description |
|---|---|---|---|
validation_method |
string | ✓ | Validation method identifier Enum: ariregister, wirtschaftscompass, bolagsverket, breg |
200 -
| Field | Type | Description |
|---|---|---|
validation_method |
string | The validation method identifier |
person_identifier_fields |
object (free-form) | Field specification for person identification. For simple identifiers: {type: 'string', field: 'civil_number', ...}. For composite identifiers: {type: 'object', fields: {...}} |
Return list of supported countries for validation
Return list of supported countries for validation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
- API Source:
onboarding_supported_countries_retrieve
1 2 3 4 5 6 7 8 9 10 | |
200 -
| Field | Type |
|---|---|
supported_countries |
array of strings |
Policies
Marketplace Customer Component Usage Policies
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/marketplace-customer-component-usage-policies/ |
List Marketplace Customer Component Usage Policies |
| GET | /api/marketplace-customer-component-usage-policies/{uuid}/ |
Retrieve |
| POST | /api/marketplace-customer-component-usage-policies/ |
Create |
| PUT | /api/marketplace-customer-component-usage-policies/{uuid}/ |
Update |
| PATCH | /api/marketplace-customer-component-usage-policies/{uuid}/ |
Partial Update |
| DELETE | /api/marketplace-customer-component-usage-policies/{uuid}/ |
Delete |
| Other Actions | ||
| GET | /api/marketplace-customer-component-usage-policies/actions/ |
List Marketplace Customer Component Usage Policies Actions |
Core CRUD
List Marketplace Customer Component Usage Policies
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
scope |
string (uri) | |
scope_uuid |
string (uuid) |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
scope |
string (uri) | |
scope_name |
string | |
scope_uuid |
string (uuid) | |
actions |
string | |
created |
string (date-time) | |
created_by_full_name |
string | |
created_by_username |
string | |
has_fired |
boolean | |
fired_datetime |
string (date-time) | |
options |
any | Fields for saving actions extra data. Keys are name of actions. |
component_limits_set |
array of objects | |
component_limits_set.type |
string | |
component_limits_set.limit |
integer | |
component_limits_set.period |
any | |
component_limits_set.period_name |
string | |
component_limits_set.component |
string (uuid) |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
scope |
string (uri) | |
scope_name |
string | |
scope_uuid |
string (uuid) | |
actions |
string | |
created |
string (date-time) | |
created_by_full_name |
string | |
created_by_username |
string | |
has_fired |
boolean | |
fired_datetime |
string (date-time) | |
options |
any | Fields for saving actions extra data. Keys are name of actions. |
component_limits_set |
array of objects | |
component_limits_set.type |
string | |
component_limits_set.limit |
integer | |
component_limits_set.period |
any | |
component_limits_set.period_name |
string | |
component_limits_set.component |
string (uuid) |
Create
1 2 3 4 5 6 7 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
CustomerComponentUsagePolicyRequest - API Source:
marketplace_customer_component_usage_policies_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
| Field | Type | Required | Description |
|---|---|---|---|
scope |
string (uri) | ✓ | |
actions |
string | ✓ | |
options |
any | Fields for saving actions extra data. Keys are name of actions. | |
component_limits_set |
array of objects | ✓ | |
component_limits_set.limit |
integer | ✓ | |
component_limits_set.period |
any | ||
component_limits_set.component |
string (uuid) | ✓ |
201 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
scope |
string (uri) | |
scope_name |
string | |
scope_uuid |
string (uuid) | |
actions |
string | |
created |
string (date-time) | |
created_by_full_name |
string | |
created_by_username |
string | |
has_fired |
boolean | |
fired_datetime |
string (date-time) | |
options |
any | Fields for saving actions extra data. Keys are name of actions. |
component_limits_set |
array of objects | |
component_limits_set.type |
string | |
component_limits_set.limit |
integer | |
component_limits_set.period |
any | |
component_limits_set.period_name |
string | |
component_limits_set.component |
string (uuid) |
Update
1 2 3 4 5 6 7 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | |
- Model Source:
CustomerComponentUsagePolicyRequest - API Source:
marketplace_customer_component_usage_policies_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
scope |
string (uri) | ✓ | |
actions |
string | ✓ | |
options |
any | Fields for saving actions extra data. Keys are name of actions. | |
component_limits_set |
array of objects | ✓ | |
component_limits_set.limit |
integer | ✓ | |
component_limits_set.period |
any | ||
component_limits_set.component |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
scope |
string (uri) | |
scope_name |
string | |
scope_uuid |
string (uuid) | |
actions |
string | |
created |
string (date-time) | |
created_by_full_name |
string | |
created_by_username |
string | |
has_fired |
boolean | |
fired_datetime |
string (date-time) | |
options |
any | Fields for saving actions extra data. Keys are name of actions. |
component_limits_set |
array of objects | |
component_limits_set.type |
string | |
component_limits_set.limit |
integer | |
component_limits_set.period |
any | |
component_limits_set.period_name |
string | |
component_limits_set.component |
string (uuid) |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedCustomerComponentUsagePolicyRequest - API Source:
marketplace_customer_component_usage_policies_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
scope |
string (uri) | ||
actions |
string | ||
options |
any | Fields for saving actions extra data. Keys are name of actions. | |
component_limits_set |
array of objects | ||
component_limits_set.limit |
integer | ✓ | |
component_limits_set.period |
any | ||
component_limits_set.component |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
scope |
string (uri) | |
scope_name |
string | |
scope_uuid |
string (uuid) | |
actions |
string | |
created |
string (date-time) | |
created_by_full_name |
string | |
created_by_username |
string | |
has_fired |
boolean | |
fired_datetime |
string (date-time) | |
options |
any | Fields for saving actions extra data. Keys are name of actions. |
component_limits_set |
array of objects | |
component_limits_set.type |
string | |
component_limits_set.limit |
integer | |
component_limits_set.period |
any | |
component_limits_set.period_name |
string | |
component_limits_set.component |
string (uuid) |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
List Marketplace Customer Component Usage Policies Actions
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
1 2 3 4 5 6 7 8 9 10 | |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
scope |
string (uri) | |
scope_name |
string | |
scope_uuid |
string (uuid) | |
actions |
string | |
created |
string (date-time) | |
created_by_full_name |
string | |
created_by_username |
string | |
has_fired |
boolean | |
fired_datetime |
string (date-time) | |
options |
any | Fields for saving actions extra data. Keys are name of actions. |
component_limits_set |
array of objects | |
component_limits_set.type |
string | |
component_limits_set.limit |
integer | |
component_limits_set.period |
any | |
component_limits_set.period_name |
string | |
component_limits_set.component |
string (uuid) |
Marketplace Customer Estimated Cost Policies
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/marketplace-customer-estimated-cost-policies/ |
List Marketplace Customer Estimated Cost Policies |
| GET | /api/marketplace-customer-estimated-cost-policies/{uuid}/ |
Retrieve |
| POST | /api/marketplace-customer-estimated-cost-policies/ |
Create |
| PUT | /api/marketplace-customer-estimated-cost-policies/{uuid}/ |
Update |
| PATCH | /api/marketplace-customer-estimated-cost-policies/{uuid}/ |
Partial Update |
| DELETE | /api/marketplace-customer-estimated-cost-policies/{uuid}/ |
Delete |
| Other Actions | ||
| GET | /api/marketplace-customer-estimated-cost-policies/actions/ |
List Marketplace Customer Estimated Cost Policies Actions |
Core CRUD
List Marketplace Customer Estimated Cost Policies
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
scope |
string (uri) | |
scope_uuid |
string (uuid) |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
scope |
string (uri) | |
scope_name |
string | |
scope_uuid |
string (uuid) | |
actions |
string | |
created |
string (date-time) | |
created_by_full_name |
string | |
created_by_username |
string | |
has_fired |
boolean | |
fired_datetime |
string (date-time) | |
options |
any | Fields for saving actions extra data. Keys are name of actions. |
limit_cost |
integer | |
period |
any | |
period_name |
string | |
customer_credit |
integer | |
billing_price_estimate |
any |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
scope |
string (uri) | |
scope_name |
string | |
scope_uuid |
string (uuid) | |
actions |
string | |
created |
string (date-time) | |
created_by_full_name |
string | |
created_by_username |
string | |
has_fired |
boolean | |
fired_datetime |
string (date-time) | |
options |
any | Fields for saving actions extra data. Keys are name of actions. |
limit_cost |
integer | |
period |
any | |
period_name |
string | |
customer_credit |
integer | |
billing_price_estimate |
any |
Create
1 2 3 4 5 6 7 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
CustomerEstimatedCostPolicyRequest - API Source:
marketplace_customer_estimated_cost_policies_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
| Field | Type | Required | Description |
|---|---|---|---|
scope |
string (uri) | ✓ | |
actions |
string | ✓ | |
options |
any | Fields for saving actions extra data. Keys are name of actions. | |
limit_cost |
integer | ✓ | |
period |
any |
201 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
scope |
string (uri) | |
scope_name |
string | |
scope_uuid |
string (uuid) | |
actions |
string | |
created |
string (date-time) | |
created_by_full_name |
string | |
created_by_username |
string | |
has_fired |
boolean | |
fired_datetime |
string (date-time) | |
options |
any | Fields for saving actions extra data. Keys are name of actions. |
limit_cost |
integer | |
period |
any | |
period_name |
string | |
customer_credit |
integer | |
billing_price_estimate |
any |
Update
1 2 3 4 5 6 7 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | |
- Model Source:
CustomerEstimatedCostPolicyRequest - API Source:
marketplace_customer_estimated_cost_policies_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
scope |
string (uri) | ✓ | |
actions |
string | ✓ | |
options |
any | Fields for saving actions extra data. Keys are name of actions. | |
limit_cost |
integer | ✓ | |
period |
any |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
scope |
string (uri) | |
scope_name |
string | |
scope_uuid |
string (uuid) | |
actions |
string | |
created |
string (date-time) | |
created_by_full_name |
string | |
created_by_username |
string | |
has_fired |
boolean | |
fired_datetime |
string (date-time) | |
options |
any | Fields for saving actions extra data. Keys are name of actions. |
limit_cost |
integer | |
period |
any | |
period_name |
string | |
customer_credit |
integer | |
billing_price_estimate |
any |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedCustomerEstimatedCostPolicyRequest - API Source:
marketplace_customer_estimated_cost_policies_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
scope |
string (uri) | ||
actions |
string | ||
options |
any | Fields for saving actions extra data. Keys are name of actions. | |
limit_cost |
integer | ||
period |
any |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
scope |
string (uri) | |
scope_name |
string | |
scope_uuid |
string (uuid) | |
actions |
string | |
created |
string (date-time) | |
created_by_full_name |
string | |
created_by_username |
string | |
has_fired |
boolean | |
fired_datetime |
string (date-time) | |
options |
any | Fields for saving actions extra data. Keys are name of actions. |
limit_cost |
integer | |
period |
any | |
period_name |
string | |
customer_credit |
integer | |
billing_price_estimate |
any |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
List Marketplace Customer Estimated Cost Policies Actions
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
1 2 3 4 5 6 7 8 9 10 | |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
scope |
string (uri) | |
scope_name |
string | |
scope_uuid |
string (uuid) | |
actions |
string | |
created |
string (date-time) | |
created_by_full_name |
string | |
created_by_username |
string | |
has_fired |
boolean | |
fired_datetime |
string (date-time) | |
options |
any | Fields for saving actions extra data. Keys are name of actions. |
limit_cost |
integer | |
period |
any | |
period_name |
string | |
customer_credit |
integer | |
billing_price_estimate |
any |
Marketplace Offering Estimated Cost Policies
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/marketplace-offering-estimated-cost-policies/ |
List Marketplace Offering Estimated Cost Policies |
| GET | /api/marketplace-offering-estimated-cost-policies/{uuid}/ |
Retrieve |
| POST | /api/marketplace-offering-estimated-cost-policies/ |
Create |
| PUT | /api/marketplace-offering-estimated-cost-policies/{uuid}/ |
Update |
| PATCH | /api/marketplace-offering-estimated-cost-policies/{uuid}/ |
Partial Update |
| DELETE | /api/marketplace-offering-estimated-cost-policies/{uuid}/ |
Delete |
| Other Actions | ||
| GET | /api/marketplace-offering-estimated-cost-policies/actions/ |
List available actions for OfferingEstimatedCostPolicy |
Core CRUD
List Marketplace Offering Estimated Cost Policies
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
scope |
string (uri) | |
scope_uuid |
string (uuid) |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
scope |
string (uri) | |
scope_name |
string | |
scope_uuid |
string (uuid) | |
actions |
string | |
created |
string (date-time) | |
created_by_full_name |
string | |
created_by_username |
string | |
has_fired |
boolean | |
fired_datetime |
string (date-time) | |
options |
any | Fields for saving actions extra data. Keys are name of actions. |
limit_cost |
integer | |
period |
any | |
period_name |
string | |
organization_groups |
array of string (uri)s | |
apply_to_all |
boolean | If True, policy applies to all customers. Mutually exclusive with organization_groups. |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
scope |
string (uri) | |
scope_name |
string | |
scope_uuid |
string (uuid) | |
actions |
string | |
created |
string (date-time) | |
created_by_full_name |
string | |
created_by_username |
string | |
has_fired |
boolean | |
fired_datetime |
string (date-time) | |
options |
any | Fields for saving actions extra data. Keys are name of actions. |
limit_cost |
integer | |
period |
any | |
period_name |
string | |
organization_groups |
array of string (uri)s | |
apply_to_all |
boolean | If True, policy applies to all customers. Mutually exclusive with organization_groups. |
Create
1 2 3 4 5 6 7 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
OfferingEstimatedCostPolicyRequest - API Source:
marketplace_offering_estimated_cost_policies_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
| Field | Type | Required | Description |
|---|---|---|---|
scope |
string (uri) | ✓ | |
actions |
string | ✓ | |
options |
any | Fields for saving actions extra data. Keys are name of actions. | |
limit_cost |
integer | ✓ | |
period |
any | ||
organization_groups |
array of string (uri)s | ||
apply_to_all |
boolean | If True, policy applies to all customers. Mutually exclusive with organization_groups. |
201 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
scope |
string (uri) | |
scope_name |
string | |
scope_uuid |
string (uuid) | |
actions |
string | |
created |
string (date-time) | |
created_by_full_name |
string | |
created_by_username |
string | |
has_fired |
boolean | |
fired_datetime |
string (date-time) | |
options |
any | Fields for saving actions extra data. Keys are name of actions. |
limit_cost |
integer | |
period |
any | |
period_name |
string | |
organization_groups |
array of string (uri)s | |
apply_to_all |
boolean | If True, policy applies to all customers. Mutually exclusive with organization_groups. |
Update
1 2 3 4 5 6 7 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | |
- Model Source:
OfferingEstimatedCostPolicyRequest - API Source:
marketplace_offering_estimated_cost_policies_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
scope |
string (uri) | ✓ | |
actions |
string | ✓ | |
options |
any | Fields for saving actions extra data. Keys are name of actions. | |
limit_cost |
integer | ✓ | |
period |
any | ||
organization_groups |
array of string (uri)s | ||
apply_to_all |
boolean | If True, policy applies to all customers. Mutually exclusive with organization_groups. |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
scope |
string (uri) | |
scope_name |
string | |
scope_uuid |
string (uuid) | |
actions |
string | |
created |
string (date-time) | |
created_by_full_name |
string | |
created_by_username |
string | |
has_fired |
boolean | |
fired_datetime |
string (date-time) | |
options |
any | Fields for saving actions extra data. Keys are name of actions. |
limit_cost |
integer | |
period |
any | |
period_name |
string | |
organization_groups |
array of string (uri)s | |
apply_to_all |
boolean | If True, policy applies to all customers. Mutually exclusive with organization_groups. |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedOfferingEstimatedCostPolicyRequest - API Source:
marketplace_offering_estimated_cost_policies_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
scope |
string (uri) | ||
actions |
string | ||
options |
any | Fields for saving actions extra data. Keys are name of actions. | |
limit_cost |
integer | ||
period |
any | ||
organization_groups |
array of string (uri)s | ||
apply_to_all |
boolean | If True, policy applies to all customers. Mutually exclusive with organization_groups. |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
scope |
string (uri) | |
scope_name |
string | |
scope_uuid |
string (uuid) | |
actions |
string | |
created |
string (date-time) | |
created_by_full_name |
string | |
created_by_username |
string | |
has_fired |
boolean | |
fired_datetime |
string (date-time) | |
options |
any | Fields for saving actions extra data. Keys are name of actions. |
limit_cost |
integer | |
period |
any | |
period_name |
string | |
organization_groups |
array of string (uri)s | |
apply_to_all |
boolean | If True, policy applies to all customers. Mutually exclusive with organization_groups. |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
List available actions for OfferingEstimatedCostPolicy
List available actions for OfferingEstimatedCostPolicy
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
1 2 3 4 5 6 7 8 9 10 | |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
scope |
string (uri) | |
scope_name |
string | |
scope_uuid |
string (uuid) | |
actions |
string | |
created |
string (date-time) | |
created_by_full_name |
string | |
created_by_username |
string | |
has_fired |
boolean | |
fired_datetime |
string (date-time) | |
options |
any | Fields for saving actions extra data. Keys are name of actions. |
limit_cost |
integer | |
period |
any | |
period_name |
string | |
organization_groups |
array of string (uri)s | |
apply_to_all |
boolean | If True, policy applies to all customers. Mutually exclusive with organization_groups. |
Marketplace Offering Usage Policies
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/marketplace-offering-usage-policies/ |
List Marketplace Offering Usage Policies |
| GET | /api/marketplace-offering-usage-policies/{uuid}/ |
Retrieve |
| POST | /api/marketplace-offering-usage-policies/ |
Create |
| PUT | /api/marketplace-offering-usage-policies/{uuid}/ |
Update |
| PATCH | /api/marketplace-offering-usage-policies/{uuid}/ |
Partial Update |
| DELETE | /api/marketplace-offering-usage-policies/{uuid}/ |
Delete |
| Other Actions | ||
| GET | /api/marketplace-offering-usage-policies/actions/ |
List Marketplace Offering Usage Policies Actions |
Core CRUD
List Marketplace Offering Usage Policies
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
marketplace_offering_usage_policies_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
scope |
string (uri) | |
scope_uuid |
string (uuid) |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
scope |
string (uri) | |
scope_name |
string | |
scope_uuid |
string (uuid) | |
actions |
string | |
created |
string (date-time) | |
created_by_full_name |
string | |
created_by_username |
string | |
has_fired |
boolean | |
fired_datetime |
string (date-time) | |
options |
any | Fields for saving actions extra data. Keys are name of actions. |
organization_groups |
array of string (uri)s | |
apply_to_all |
boolean | If True, policy applies to all customers. Mutually exclusive with organization_groups. |
component_limits_set |
array of objects | |
component_limits_set.type |
string | |
component_limits_set.limit |
integer | |
period |
any | |
period_name |
string |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_offering_usage_policies_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
scope |
string (uri) | |
scope_name |
string | |
scope_uuid |
string (uuid) | |
actions |
string | |
created |
string (date-time) | |
created_by_full_name |
string | |
created_by_username |
string | |
has_fired |
boolean | |
fired_datetime |
string (date-time) | |
options |
any | Fields for saving actions extra data. Keys are name of actions. |
organization_groups |
array of string (uri)s | |
apply_to_all |
boolean | If True, policy applies to all customers. Mutually exclusive with organization_groups. |
component_limits_set |
array of objects | |
component_limits_set.type |
string | |
component_limits_set.limit |
integer | |
period |
any | |
period_name |
string |
Create
1 2 3 4 5 6 7 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
OfferingUsagePolicyRequest - API Source:
marketplace_offering_usage_policies_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
| Field | Type | Required | Description |
|---|---|---|---|
scope |
string (uri) | ✓ | |
actions |
string | ✓ | |
options |
any | Fields for saving actions extra data. Keys are name of actions. | |
organization_groups |
array of string (uri)s | ||
apply_to_all |
boolean | If True, policy applies to all customers. Mutually exclusive with organization_groups. | |
component_limits_set |
array of objects | ✓ | |
component_limits_set.type |
string | ✓ | |
component_limits_set.limit |
integer | ✓ | |
period |
any |
201 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
scope |
string (uri) | |
scope_name |
string | |
scope_uuid |
string (uuid) | |
actions |
string | |
created |
string (date-time) | |
created_by_full_name |
string | |
created_by_username |
string | |
has_fired |
boolean | |
fired_datetime |
string (date-time) | |
options |
any | Fields for saving actions extra data. Keys are name of actions. |
organization_groups |
array of string (uri)s | |
apply_to_all |
boolean | If True, policy applies to all customers. Mutually exclusive with organization_groups. |
component_limits_set |
array of objects | |
component_limits_set.type |
string | |
component_limits_set.limit |
integer | |
period |
any | |
period_name |
string |
Update
1 2 3 4 5 6 7 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | |
- Model Source:
OfferingUsagePolicyRequest - API Source:
marketplace_offering_usage_policies_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
scope |
string (uri) | ✓ | |
actions |
string | ✓ | |
options |
any | Fields for saving actions extra data. Keys are name of actions. | |
organization_groups |
array of string (uri)s | ||
apply_to_all |
boolean | If True, policy applies to all customers. Mutually exclusive with organization_groups. | |
component_limits_set |
array of objects | ✓ | |
component_limits_set.type |
string | ✓ | |
component_limits_set.limit |
integer | ✓ | |
period |
any |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
scope |
string (uri) | |
scope_name |
string | |
scope_uuid |
string (uuid) | |
actions |
string | |
created |
string (date-time) | |
created_by_full_name |
string | |
created_by_username |
string | |
has_fired |
boolean | |
fired_datetime |
string (date-time) | |
options |
any | Fields for saving actions extra data. Keys are name of actions. |
organization_groups |
array of string (uri)s | |
apply_to_all |
boolean | If True, policy applies to all customers. Mutually exclusive with organization_groups. |
component_limits_set |
array of objects | |
component_limits_set.type |
string | |
component_limits_set.limit |
integer | |
period |
any | |
period_name |
string |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedOfferingUsagePolicyRequest - API Source:
marketplace_offering_usage_policies_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
scope |
string (uri) | ||
actions |
string | ||
options |
any | Fields for saving actions extra data. Keys are name of actions. | |
organization_groups |
array of string (uri)s | ||
apply_to_all |
boolean | If True, policy applies to all customers. Mutually exclusive with organization_groups. | |
component_limits_set |
array of objects | ||
component_limits_set.type |
string | ✓ | |
component_limits_set.limit |
integer | ✓ | |
period |
any |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
scope |
string (uri) | |
scope_name |
string | |
scope_uuid |
string (uuid) | |
actions |
string | |
created |
string (date-time) | |
created_by_full_name |
string | |
created_by_username |
string | |
has_fired |
boolean | |
fired_datetime |
string (date-time) | |
options |
any | Fields for saving actions extra data. Keys are name of actions. |
organization_groups |
array of string (uri)s | |
apply_to_all |
boolean | If True, policy applies to all customers. Mutually exclusive with organization_groups. |
component_limits_set |
array of objects | |
component_limits_set.type |
string | |
component_limits_set.limit |
integer | |
period |
any | |
period_name |
string |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_offering_usage_policies_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
List Marketplace Offering Usage Policies Actions
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
1 2 3 4 5 6 7 8 9 10 | |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
scope |
string (uri) | |
scope_name |
string | |
scope_uuid |
string (uuid) | |
actions |
string | |
created |
string (date-time) | |
created_by_full_name |
string | |
created_by_username |
string | |
has_fired |
boolean | |
fired_datetime |
string (date-time) | |
options |
any | Fields for saving actions extra data. Keys are name of actions. |
organization_groups |
array of string (uri)s | |
apply_to_all |
boolean | If True, policy applies to all customers. Mutually exclusive with organization_groups. |
component_limits_set |
array of objects | |
component_limits_set.type |
string | |
component_limits_set.limit |
integer | |
period |
any | |
period_name |
string |
Marketplace Project Estimated Cost Policies
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/marketplace-project-estimated-cost-policies/ |
List Marketplace Project Estimated Cost Policies |
| GET | /api/marketplace-project-estimated-cost-policies/{uuid}/ |
Retrieve |
| POST | /api/marketplace-project-estimated-cost-policies/ |
Create |
| PUT | /api/marketplace-project-estimated-cost-policies/{uuid}/ |
Update |
| PATCH | /api/marketplace-project-estimated-cost-policies/{uuid}/ |
Partial Update |
| DELETE | /api/marketplace-project-estimated-cost-policies/{uuid}/ |
Delete |
| Other Actions | ||
| GET | /api/marketplace-project-estimated-cost-policies/actions/ |
List Marketplace Project Estimated Cost Policies Actions |
Core CRUD
List Marketplace Project Estimated Cost Policies
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
marketplace_project_estimated_cost_policies_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
project |
string (uri) | |
project_uuid |
string (uuid) | |
scope |
string (uri) | |
scope_uuid |
string (uuid) |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
scope |
string (uri) | |
scope_name |
string | |
scope_uuid |
string (uuid) | |
actions |
string | |
created |
string (date-time) | |
created_by_full_name |
string | |
created_by_username |
string | |
has_fired |
boolean | |
fired_datetime |
string (date-time) | |
options |
any | Fields for saving actions extra data. Keys are name of actions. |
limit_cost |
integer | |
period |
any | |
period_name |
string | |
project_credit |
number (double) | |
customer_credit |
number (double) | |
billing_price_estimate |
any |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
scope |
string (uri) | |
scope_name |
string | |
scope_uuid |
string (uuid) | |
actions |
string | |
created |
string (date-time) | |
created_by_full_name |
string | |
created_by_username |
string | |
has_fired |
boolean | |
fired_datetime |
string (date-time) | |
options |
any | Fields for saving actions extra data. Keys are name of actions. |
limit_cost |
integer | |
period |
any | |
period_name |
string | |
project_credit |
number (double) | |
customer_credit |
number (double) | |
billing_price_estimate |
any |
Create
1 2 3 4 5 6 7 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
ProjectEstimatedCostPolicyRequest - API Source:
marketplace_project_estimated_cost_policies_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
| Field | Type | Required | Description |
|---|---|---|---|
scope |
string (uri) | ✓ | |
actions |
string | ✓ | |
options |
any | Fields for saving actions extra data. Keys are name of actions. | |
limit_cost |
integer | ✓ | |
period |
any |
201 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
scope |
string (uri) | |
scope_name |
string | |
scope_uuid |
string (uuid) | |
actions |
string | |
created |
string (date-time) | |
created_by_full_name |
string | |
created_by_username |
string | |
has_fired |
boolean | |
fired_datetime |
string (date-time) | |
options |
any | Fields for saving actions extra data. Keys are name of actions. |
limit_cost |
integer | |
period |
any | |
period_name |
string | |
project_credit |
number (double) | |
customer_credit |
number (double) | |
billing_price_estimate |
any |
Update
1 2 3 4 5 6 7 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | |
- Model Source:
ProjectEstimatedCostPolicyRequest - API Source:
marketplace_project_estimated_cost_policies_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
scope |
string (uri) | ✓ | |
actions |
string | ✓ | |
options |
any | Fields for saving actions extra data. Keys are name of actions. | |
limit_cost |
integer | ✓ | |
period |
any |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
scope |
string (uri) | |
scope_name |
string | |
scope_uuid |
string (uuid) | |
actions |
string | |
created |
string (date-time) | |
created_by_full_name |
string | |
created_by_username |
string | |
has_fired |
boolean | |
fired_datetime |
string (date-time) | |
options |
any | Fields for saving actions extra data. Keys are name of actions. |
limit_cost |
integer | |
period |
any | |
period_name |
string | |
project_credit |
number (double) | |
customer_credit |
number (double) | |
billing_price_estimate |
any |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedProjectEstimatedCostPolicyRequest - API Source:
marketplace_project_estimated_cost_policies_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
scope |
string (uri) | ||
actions |
string | ||
options |
any | Fields for saving actions extra data. Keys are name of actions. | |
limit_cost |
integer | ||
period |
any |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
scope |
string (uri) | |
scope_name |
string | |
scope_uuid |
string (uuid) | |
actions |
string | |
created |
string (date-time) | |
created_by_full_name |
string | |
created_by_username |
string | |
has_fired |
boolean | |
fired_datetime |
string (date-time) | |
options |
any | Fields for saving actions extra data. Keys are name of actions. |
limit_cost |
integer | |
period |
any | |
period_name |
string | |
project_credit |
number (double) | |
customer_credit |
number (double) | |
billing_price_estimate |
any |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
List Marketplace Project Estimated Cost Policies Actions
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
1 2 3 4 5 6 7 8 9 10 | |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
scope |
string (uri) | |
scope_name |
string | |
scope_uuid |
string (uuid) | |
actions |
string | |
created |
string (date-time) | |
created_by_full_name |
string | |
created_by_username |
string | |
has_fired |
boolean | |
fired_datetime |
string (date-time) | |
options |
any | Fields for saving actions extra data. Keys are name of actions. |
limit_cost |
integer | |
period |
any | |
period_name |
string | |
project_credit |
number (double) | |
customer_credit |
number (double) | |
billing_price_estimate |
any |
Promotions
Promotions Campaigns
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/promotions-campaigns/ |
List Promotions Campaigns |
| GET | /api/promotions-campaigns/{uuid}/ |
Retrieve |
| POST | /api/promotions-campaigns/ |
Create |
| PUT | /api/promotions-campaigns/{uuid}/ |
Update |
| DELETE | /api/promotions-campaigns/{uuid}/ |
Delete |
| Other Actions | ||
| GET | /api/promotions-campaigns/{uuid}/orders/ |
Return a list of orders for which the campaign is applied |
| GET | /api/promotions-campaigns/{uuid}/resources/ |
Return a list of resources for which the campaign is applied |
| POST | /api/promotions-campaigns/{uuid}/activate/ |
Activate campaign |
| POST | /api/promotions-campaigns/{uuid}/terminate/ |
Terminate campaign |
Core CRUD
List Promotions Campaigns
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- Model Source:
CampaignOEnum - Model Source:
CampaignStateEnum - API Source:
promotions_campaigns_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
discount_type |
string | |
end_date |
string (date) | |
o |
array | Ordering |
offering |
string (uri) | Offering |
offering_uuid |
string (uuid) | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
query |
string | Search by name or coupon code |
service_provider_uuid |
string (uuid) | |
start_date |
string (date) | |
state |
array |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
name |
string | |
url |
string (uri) | |
start_date |
string (date) | Starting from this date, the campaign is active. |
end_date |
string (date) | The last day the campaign is active. |
coupon |
string | If coupon is empty, campaign is available to all users. |
discount_type |
string | Enum: discount, special_price |
discount |
integer | |
stock |
integer | |
description |
string | |
months |
integer | How many months in a row should the related service (when activated) get special deal (0 for indefinitely until active) |
auto_apply |
boolean | |
state |
string | |
service_provider |
string (uri) | |
offerings |
array of objects | |
offerings.uuid |
string (uuid) | |
offerings.name |
string | |
required_offerings |
array of string (uuid)s |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
promotions_campaigns_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
name |
string | |
url |
string (uri) | |
start_date |
string (date) | Starting from this date, the campaign is active. |
end_date |
string (date) | The last day the campaign is active. |
coupon |
string | If coupon is empty, campaign is available to all users. |
discount_type |
string | Enum: discount, special_price |
discount |
integer | |
stock |
integer | |
description |
string | |
months |
integer | How many months in a row should the related service (when activated) get special deal (0 for indefinitely until active) |
auto_apply |
boolean | |
state |
string | |
service_provider |
string (uri) | |
offerings |
array of objects | |
offerings.uuid |
string (uuid) | |
offerings.name |
string | |
required_offerings |
array of string (uuid)s |
Create
1 2 3 4 5 6 7 8 9 10 11 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 | |
- Model Source:
CampaignRequest - API Source:
promotions_campaigns_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ✓ | |
start_date |
string (date) | ✓ | Starting from this date, the campaign is active. |
end_date |
string (date) | ✓ | The last day the campaign is active. |
coupon |
string | If coupon is empty, campaign is available to all users. | |
discount_type |
string | ✓ | Enum: discount, special_price |
discount |
integer | ✓ | |
stock |
integer | ||
description |
string | ||
months |
integer | How many months in a row should the related service (when activated) get special deal (0 for indefinitely until active) | |
auto_apply |
boolean | ||
service_provider |
string (uri) | ✓ | |
offerings |
array of string (uuid)s | ✓ | Constraints: write-only |
required_offerings |
array of string (uuid)s |
201 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
name |
string | |
url |
string (uri) | |
start_date |
string (date) | Starting from this date, the campaign is active. |
end_date |
string (date) | The last day the campaign is active. |
coupon |
string | If coupon is empty, campaign is available to all users. |
discount_type |
string | Enum: discount, special_price |
discount |
integer | |
stock |
integer | |
description |
string | |
months |
integer | How many months in a row should the related service (when activated) get special deal (0 for indefinitely until active) |
auto_apply |
boolean | |
state |
string | |
service_provider |
string (uri) | |
offerings |
array of objects | |
offerings.uuid |
string (uuid) | |
offerings.name |
string | |
required_offerings |
array of string (uuid)s |
Update
1 2 3 4 5 6 7 8 9 10 11 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 | |
- Model Source:
CampaignRequest - API Source:
promotions_campaigns_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ✓ | |
start_date |
string (date) | ✓ | Starting from this date, the campaign is active. |
end_date |
string (date) | ✓ | The last day the campaign is active. |
coupon |
string | If coupon is empty, campaign is available to all users. | |
discount_type |
string | ✓ | Enum: discount, special_price |
discount |
integer | ✓ | |
stock |
integer | ||
description |
string | ||
months |
integer | How many months in a row should the related service (when activated) get special deal (0 for indefinitely until active) | |
auto_apply |
boolean | ||
service_provider |
string (uri) | ✓ | |
offerings |
array of string (uuid)s | ✓ | Constraints: write-only |
required_offerings |
array of string (uuid)s |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
name |
string | |
url |
string (uri) | |
start_date |
string (date) | Starting from this date, the campaign is active. |
end_date |
string (date) | The last day the campaign is active. |
coupon |
string | If coupon is empty, campaign is available to all users. |
discount_type |
string | Enum: discount, special_price |
discount |
integer | |
stock |
integer | |
description |
string | |
months |
integer | How many months in a row should the related service (when activated) get special deal (0 for indefinitely until active) |
auto_apply |
boolean | |
state |
string | |
service_provider |
string (uri) | |
offerings |
array of objects | |
offerings.uuid |
string (uuid) | |
offerings.name |
string | |
required_offerings |
array of string (uuid)s |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
promotions_campaigns_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
Return a list of orders for which the campaign is applied
Return a list of orders for which the campaign is applied.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
- Model Source:
OrderDetailsFieldEnum - API Source:
promotions_campaigns_orders_list
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
field |
array | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
offering |
string (uri) | |
offering_name |
string | |
offering_uuid |
string (uuid) | |
offering_description |
string | |
offering_image |
string (uri) | |
offering_thumbnail |
string (uri) | |
offering_type |
string | |
offering_shared |
boolean | Accessible to all customers. |
offering_billable |
boolean | Purchase and usage is invoiced. |
offering_plugin_options |
any | Public data used by specific plugin, such as storage mode for OpenStack. |
provider_name |
string | |
provider_uuid |
string (uuid) | |
provider_slug |
string | |
category_title |
string | |
category_uuid |
string (uuid) | |
category_icon |
string (uri) | |
plan |
string (uri) | |
plan_unit |
any | |
plan_name |
string | |
plan_uuid |
string (uuid) | |
plan_description |
string | |
attributes |
any | |
limits |
object (free-form) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
modified |
string (date-time) | |
resource_uuid |
string (uuid) | |
resource_type |
string | |
resource_name |
string | |
cost |
string (decimal) | |
state |
any | |
output |
string | |
marketplace_resource_uuid |
string (uuid) | |
error_message |
string | |
error_traceback |
string | |
callback_url |
string (uri) | |
completed_at |
string (date-time) | |
request_comment |
string | |
attachment |
string (uri) | |
type |
any | |
start_date |
string (date) | Enables delayed processing of resource provisioning order. |
slug |
string | |
url |
string (uri) | |
consumer_reviewed_by |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
consumer_reviewed_by_full_name |
string | |
consumer_reviewed_by_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
consumer_reviewed_at |
string (date-time) | |
provider_reviewed_by |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
provider_reviewed_by_full_name |
string | |
provider_reviewed_by_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
provider_reviewed_at |
string (date-time) | |
created_by_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
created_by_full_name |
string | |
created_by_civil_number |
string | |
created_by_email |
string (email) | |
created_by_organization |
string | |
created_by_organization_registry_code |
string | Company registration code of the user's organization, if known |
customer_name |
string | |
customer_uuid |
string (uuid) | |
customer_slug |
string | |
project_name |
string | |
project_uuid |
string (uuid) | |
project_description |
string | |
project_slug |
string | |
old_plan_name |
string | |
new_plan_name |
string | |
old_plan_uuid |
string (uuid) | |
new_plan_uuid |
string (uuid) | |
old_cost_estimate |
number (double) | |
new_cost_estimate |
string (decimal) | |
can_terminate |
boolean | |
fixed_price |
number (double) | |
activation_price |
number (double) | |
termination_comment |
string | |
backend_id |
string | |
order_subtype |
string | |
provider_message |
string | |
provider_message_url |
string (uri) | |
provider_message_attachment |
string (uri) | |
consumer_message |
string | |
consumer_message_attachment |
string (uri) | |
consumer_rejection_comment |
string | |
provider_rejection_comment |
string | |
issue |
any |
Return a list of resources for which the campaign is applied
Return a list of resources for which the campaign is applied.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
- Model Source:
ResourceFieldEnum - API Source:
promotions_campaigns_resources_list
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
field |
array | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
offering |
string (uri) | |
offering_name |
string | |
offering_uuid |
string (uuid) | |
offering_description |
string | |
offering_image |
string (uri) | |
offering_thumbnail |
string (uri) | |
offering_type |
string | |
offering_shared |
boolean | Accessible to all customers. |
offering_billable |
boolean | Purchase and usage is invoiced. |
offering_plugin_options |
any | Public data used by specific plugin, such as storage mode for OpenStack. |
provider_name |
string | |
provider_uuid |
string (uuid) | |
provider_slug |
string | |
category_title |
string | |
category_uuid |
string (uuid) | |
category_icon |
string (uri) | |
plan |
string (uri) | |
plan_unit |
any | |
plan_name |
string | |
plan_uuid |
string (uuid) | |
plan_description |
string | |
attributes |
object (free-form) | |
limits |
object (free-form) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
modified |
string (date-time) | |
url |
string (uri) | |
scope |
string | |
description |
string | |
state |
any | |
resource_uuid |
string (uuid) | |
backend_id |
string | |
effective_id |
string | |
resource_type |
string | |
project |
string (uri) | |
project_uuid |
string (uuid) | |
project_name |
string | |
project_description |
string | |
project_end_date |
string (date) | The date is inclusive. Once reached, all project resource will be scheduled for termination. |
project_end_date_requested_by |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
offering_slug |
string | |
parent_offering_uuid |
string (uuid) | |
parent_offering_name |
string | |
parent_offering_slug |
string | |
offering_backend_id |
string | |
parent_uuid |
string (uuid) | |
parent_name |
string | |
backend_metadata |
any | |
is_usage_based |
boolean | Returns True if the resource has usage-based components that track variable consumption. |
is_limit_based |
boolean | Returns True if the resource has limit-based components with user-adjustable quotas. |
name |
string | |
slug |
string | URL-friendly identifier. Only editable by staff users. |
current_usages |
object (free-form) | Dictionary mapping component types to their latest reported usage amounts. |
can_terminate |
boolean | |
report |
array of objects | |
report.header |
string | Section header text |
report.body |
string | Section body content |
end_date |
string (date) | The date is inclusive. Once reached, a resource will be scheduled for termination. |
end_date_requested_by |
string (uri) | |
username |
string | |
limit_usage |
object (free-form) | Dictionary mapping limit-based component types to their consumed usage. For monthly periods, maps from current_usages; for longer periods, aggregates historical usage. |
downscaled |
boolean | |
restrict_member_access |
boolean | |
paused |
boolean | |
endpoints |
array of objects | |
endpoints.uuid |
string (uuid) | |
endpoints.name |
string | |
endpoints.url |
string | URL of the access endpoint |
error_message |
string | |
error_traceback |
string | |
options |
any | |
available_actions |
array of strings | |
last_sync |
string (date-time) | |
order_in_progress |
any | |
creation_order |
any | |
service_settings_uuid |
string (uuid) | |
project_slug |
string | |
customer_slug |
string | |
user_requires_reconsent |
boolean | Check if the current user needs to re-consent for this resource's offering. |
renewal_date |
object (free-form) | |
offering_state |
any | |
offering_components |
array of objects | |
offering_components.uuid |
string (uuid) | |
offering_components.billing_type |
string | Enum: fixed, usage, limit, one, few |
offering_components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
offering_components.name |
string | Display name for the measured unit, for example, Floating IP. |
offering_components.description |
string | |
offering_components.measured_unit |
string | Unit of measurement, for example, GB. |
offering_components.unit_factor |
integer | The conversion factor from backend units to measured_unit |
offering_components.limit_period |
any | |
offering_components.limit_amount |
integer | |
offering_components.article_code |
string | |
offering_components.max_value |
integer | |
offering_components.min_value |
integer | |
offering_components.max_available_limit |
integer | |
offering_components.is_boolean |
boolean | |
offering_components.default_limit |
integer | |
offering_components.factor |
integer | |
offering_components.is_builtin |
boolean | |
offering_components.is_prepaid |
boolean | |
offering_components.overage_component |
string (uuid) | |
offering_components.min_prepaid_duration |
integer | |
offering_components.max_prepaid_duration |
integer |
Activate campaign
Activate campaign.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
promotions_campaigns_activate
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - No response body
409 - No response body
Terminate campaign
Terminate campaign.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
promotions_campaigns_terminate
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - No response body
409 - No response body
Provider api
Marketplace Provider Offerings
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/marketplace-provider-offerings/ |
List provider offerings |
| GET | /api/marketplace-provider-offerings/{uuid}/ |
Retrieve a provider offering |
| POST | /api/marketplace-provider-offerings/ |
Create a provider offering |
| DELETE | /api/marketplace-provider-offerings/{uuid}/ |
Delete a provider offering |
| State Management | ||
| POST | /api/marketplace-provider-offerings/{uuid}/activate/ |
Activate an offering |
| POST | /api/marketplace-provider-offerings/{uuid}/archive/ |
Archive an offering |
| POST | /api/marketplace-provider-offerings/{uuid}/draft/ |
Move an offering to draft |
| POST | /api/marketplace-provider-offerings/{uuid}/pause/ |
Pause an offering |
| POST | /api/marketplace-provider-offerings/{uuid}/unpause/ |
Unpause an offering |
| Users and Accounts | ||
| GET | /api/marketplace-provider-offerings/{uuid}/glauth_users_config/ |
Get GLauth user configuration |
| GET | /api/marketplace-provider-offerings/{uuid}/list_course_accounts/ |
List course accounts for an offering |
| GET | /api/marketplace-provider-offerings/{uuid}/list_customer_service_accounts/ |
List customer service accounts for an offering |
| GET | /api/marketplace-provider-offerings/{uuid}/list_customer_users/ |
List customer users for an offering |
| GET | /api/marketplace-provider-offerings/{uuid}/list_project_service_accounts/ |
List project service accounts for an offering |
| GET | /api/marketplace-provider-offerings/{uuid}/list_users/ |
List users and their roles in a scope |
| GET | /api/marketplace-provider-offerings/{uuid}/user_has_resource_access/ |
Check user access to offering resources |
| POST | /api/marketplace-provider-offerings/{uuid}/add_user/ |
Grant a role to a user |
| POST | /api/marketplace-provider-offerings/{uuid}/delete_user/ |
Revoke a role from a user |
| POST | /api/marketplace-provider-offerings/{uuid}/refresh_offering_usernames/ |
Refresh offering user usernames |
| POST | /api/marketplace-provider-offerings/{uuid}/update_user/ |
Update a user's role expiration |
| POST | /api/marketplace-provider-offerings/{uuid}/update-user-attribute-config/ |
Update user attribute config |
| PUT | /api/marketplace-provider-offerings/{uuid}/update-user-attribute-config/ |
Update user attribute config |
| PATCH | /api/marketplace-provider-offerings/{uuid}/update-user-attribute-config/ |
Update user attribute config |
| DELETE | /api/marketplace-provider-offerings/{uuid}/delete-user-attribute-config/ |
Delete user attribute config |
| Offering Components | ||
| POST | /api/marketplace-provider-offerings/{uuid}/create_offering_component/ |
Create an offering component |
| POST | /api/marketplace-provider-offerings/{uuid}/remove_offering_component/ |
Remove an offering component |
| POST | /api/marketplace-provider-offerings/{uuid}/update_offering_component/ |
Update an offering component |
| Software Catalogs and Partitions | ||
| POST | /api/marketplace-provider-offerings/{uuid}/add_partition/ |
Add a partition to an offering |
| POST | /api/marketplace-provider-offerings/{uuid}/add_software_catalog/ |
Add a software catalog to an offering |
| POST | /api/marketplace-provider-offerings/{uuid}/remove_partition/ |
Remove a partition from an offering |
| POST | /api/marketplace-provider-offerings/{uuid}/remove_software_catalog/ |
Remove a software catalog from an offering |
| PATCH | /api/marketplace-provider-offerings/{uuid}/update_partition/ |
Update a partition of an offering |
| PATCH | /api/marketplace-provider-offerings/{uuid}/update_software_catalog/ |
Update software catalog configuration |
| Endpoints | ||
| POST | /api/marketplace-provider-offerings/{uuid}/add_endpoint/ |
Add an access endpoint to an offering |
| POST | /api/marketplace-provider-offerings/{uuid}/delete_endpoint/ |
Delete an access endpoint from an offering |
| Attachments and Images | ||
| POST | /api/marketplace-provider-offerings/{uuid}/delete_image/ |
Delete offering image |
| POST | /api/marketplace-provider-offerings/{uuid}/delete_thumbnail/ |
Delete offering thumbnail |
| POST | /api/marketplace-provider-offerings/{uuid}/update_image/ |
Update offering image |
| POST | /api/marketplace-provider-offerings/{uuid}/update_thumbnail/ |
Update offering thumbnail |
| Configuration & Updates | ||
| POST | /api/marketplace-provider-offerings/{uuid}/delete_organization_groups/ |
Delete organization groups for offering |
| POST | /api/marketplace-provider-offerings/{uuid}/move_offering/ |
Move an offering |
| POST | /api/marketplace-provider-offerings/{uuid}/set_backend_metadata/ |
Set offering backend metadata |
| POST | /api/marketplace-provider-offerings/{uuid}/update_attributes/ |
Update offering attributes |
| POST | /api/marketplace-provider-offerings/{uuid}/update_compliance_checklist/ |
Update offering compliance checklist |
| POST | /api/marketplace-provider-offerings/{uuid}/update_description/ |
Update offering category |
| POST | /api/marketplace-provider-offerings/{uuid}/update_integration/ |
Update offering integration settings |
| POST | /api/marketplace-provider-offerings/{uuid}/update_location/ |
Update offering location |
| POST | /api/marketplace-provider-offerings/{uuid}/update_options/ |
Update offering options |
| POST | /api/marketplace-provider-offerings/{uuid}/update_organization_groups/ |
Update organization groups for offering |
| POST | /api/marketplace-provider-offerings/{uuid}/update_overview/ |
Update offering overview |
| POST | /api/marketplace-provider-offerings/{uuid}/update_resource_options/ |
Update offering resource options |
| Data & Reporting | ||
| GET | /api/marketplace-provider-offerings/{uuid}/component_stats/ |
Get statistics for offering components |
| GET | /api/marketplace-provider-offerings/{uuid}/costs/ |
Get costs for an offering |
| GET | /api/marketplace-provider-offerings/{uuid}/customers/ |
Get customers for an offering |
| GET | /api/marketplace-provider-offerings/groups/ |
List offerings grouped by provider |
| GET | /api/marketplace-provider-offerings/{uuid}/list_customer_projects/ |
List customer projects for an offering |
| GET | /api/marketplace-provider-offerings/{uuid}/orders/ |
List orders for an offering |
| GET | /api/marketplace-provider-offerings/{uuid}/orders/{order_uuid}/ |
Retrieve a specific order for an offering |
| GET | /api/marketplace-provider-offerings/{uuid}/stats/ |
Get offering statistics |
| GET | /api/marketplace-provider-offerings/{uuid}/tos_stats/ |
Get Terms of Service consent statistics |
| Remote Actions & Sync | ||
| GET | /api/marketplace-provider-offerings/{uuid}/importable_resources/ |
List importable resources |
| POST | /api/marketplace-provider-offerings/{uuid}/import_resource/ |
Import a resource |
| POST | /api/marketplace-provider-offerings/{uuid}/sync/ |
Synchronize offering service settings |
| Other Actions | ||
| GET | /api/marketplace-provider-offerings/{uuid}/history/at/ |
Get object state at a specific timestamp |
| GET | /api/marketplace-provider-offerings/{uuid}/history/ |
Get version history |
| GET | /api/marketplace-provider-offerings/{uuid}/user-attribute-config/ |
Get user attribute config |
| POST | /api/marketplace-provider-offerings/{uuid}/check_unique_backend_id/ |
Check if backend_id is unique |
| POST | /api/marketplace-provider-offerings/{uuid}/delete_tags/ |
Delete tags for offering |
| POST | /api/marketplace-provider-offerings/{uuid}/export_offering/ |
Export offering data |
| POST | /api/marketplace-provider-offerings/import_offering/ |
Import offering data |
| POST | /api/marketplace-provider-offerings/{uuid}/make_available/ |
Mark an offering as available |
| POST | /api/marketplace-provider-offerings/{uuid}/make_unavailable/ |
Mark an offering as unavailable |
| POST | /api/marketplace-provider-offerings/{uuid}/update_backend_id_rules/ |
Update offering backend_id rules |
| POST | /api/marketplace-provider-offerings/{uuid}/update_tags/ |
Update tags for offering |
Core CRUD
List provider offerings
Returns a paginated list of offerings for the provider.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
OfferingState - Model Source:
ProviderOfferingDetailsFieldEnum - Model Source:
ProviderOfferingDetailsOEnum - API Source:
marketplace_provider_offerings_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
accessible_via_calls |
boolean | Accessible via calls |
allowed_customer_uuid |
string (uuid) | Allowed customer UUID |
attributes |
string | Offering attributes (JSON) |
billable |
boolean | Billable |
can_create_offering_user |
boolean | |
category_group_uuid |
string (uuid) | Category group UUID |
category_uuid |
string (uuid) | Category UUID |
created |
string (date-time) | Created after |
customer |
string (uri) | Customer URL |
customer_uuid |
string (uuid) | Customer UUID |
description |
string | Description contains |
field |
array | |
has_active_terms_of_service |
boolean | Has Active Terms of Service |
has_terms_of_service |
boolean | Has Terms of Service |
importable |
string | Filter by importable offerings. |
keyword |
string | Keyword |
modified |
string (date-time) | Modified after |
name |
string | Name |
name_exact |
string | Name (exact) |
o |
array | Ordering |
organization_group_uuid |
string (uuid) | Organization group UUID |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
parent_uuid |
string (uuid) | Parent offering UUID |
project_uuid |
string (uuid) | Project UUID |
query |
string | Search by offering name, slug or description |
resource_customer_uuid |
string (uuid) | Resource customer UUID |
resource_project_uuid |
string (uuid) | Resource project UUID |
scope_uuid |
string | Scope UUID |
service_manager_uuid |
string (uuid) | Service manager UUID |
shared |
boolean | Shared |
state |
array | Offering state |
tag |
array | Tag UUID (OR logic) |
tag_name |
array | Tag name (OR logic) |
tag_names_and |
string | Tag names with AND logic (comma-separated) |
tags_and |
string | Tag UUIDs with AND logic (comma-separated) |
type |
array | Offering type |
user_has_consent |
boolean | User Has Consent |
user_has_offering_user |
boolean | User Has Offering User |
uuid_list |
string | Comma-separated offering UUIDs |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
name |
string | |
slug |
string | URL-friendly identifier. Only editable by staff users. |
description |
string | |
full_description |
string | |
privacy_policy_link |
string (uri) | |
access_url |
string (uri) | Publicly accessible offering access URL |
endpoints |
array of objects | |
endpoints.uuid |
string (uuid) | |
endpoints.name |
string | |
endpoints.url |
string | URL of the access endpoint |
software_catalogs |
array of objects | |
software_catalogs.uuid |
string (uuid) | |
software_catalogs.catalog |
any | |
software_catalogs.enabled_cpu_family |
any | List of enabled CPU families: ['x86_64', 'aarch64'] |
software_catalogs.enabled_cpu_microarchitectures |
any | List of enabled CPU microarchitectures: ['generic', 'zen3'] |
software_catalogs.package_count |
integer | |
software_catalogs.partition |
any | |
partitions |
array of objects | |
partitions.uuid |
string (uuid) | |
partitions.partition_name |
string | Name of the SLURM partition |
partitions.cpu_bind |
integer | Default task binding policy (SLURM cpu_bind) |
partitions.def_cpu_per_gpu |
integer | Default CPUs allocated per GPU |
partitions.max_cpus_per_node |
integer | Maximum allocated CPUs per node |
partitions.max_cpus_per_socket |
integer | Maximum allocated CPUs per socket |
partitions.def_mem_per_cpu |
integer (int64) | Default memory per CPU in MB |
partitions.def_mem_per_gpu |
integer (int64) | Default memory per GPU in MB |
partitions.def_mem_per_node |
integer (int64) | Default memory per node in MB |
partitions.max_mem_per_cpu |
integer (int64) | Maximum memory per CPU in MB |
partitions.max_mem_per_node |
integer (int64) | Maximum memory per node in MB |
partitions.default_time |
integer | Default time limit in minutes |
partitions.max_time |
integer | Maximum time limit in minutes |
partitions.grace_time |
integer | Preemption grace time in seconds |
partitions.max_nodes |
integer | Maximum nodes per job |
partitions.min_nodes |
integer | Minimum nodes per job |
partitions.exclusive_topo |
boolean | Exclusive topology access required |
partitions.exclusive_user |
boolean | Exclusive user access required |
partitions.priority_tier |
integer | Priority tier for scheduling and preemption |
partitions.qos |
string | Quality of Service (QOS) name |
partitions.req_resv |
boolean | Require reservation for job allocation |
roles |
array of objects | |
roles.uuid |
string (uuid) | |
roles.name |
string | |
roles.url |
string (uri) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
project |
string (uri) | |
project_uuid |
string (uuid) | |
project_name |
string | |
category |
string (uri) | |
category_uuid |
string (uuid) | |
category_title |
string | |
attributes |
object (free-form) | |
options |
any | |
resource_options |
any | |
components |
array of objects | |
components.uuid |
string (uuid) | |
components.billing_type |
string | Enum: fixed, usage, limit, one, few |
components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
components.name |
string | Display name for the measured unit, for example, Floating IP. |
components.description |
string | |
components.measured_unit |
string | Unit of measurement, for example, GB. |
components.unit_factor |
integer | The conversion factor from backend units to measured_unit |
components.limit_period |
any | |
components.limit_amount |
integer | |
components.article_code |
string | |
components.max_value |
integer | |
components.min_value |
integer | |
components.max_available_limit |
integer | |
components.is_boolean |
boolean | |
components.default_limit |
integer | |
components.factor |
integer | |
components.is_builtin |
boolean | |
components.is_prepaid |
boolean | |
components.overage_component |
string (uuid) | |
components.min_prepaid_duration |
integer | |
components.max_prepaid_duration |
integer | |
plugin_options |
any | |
secret_options |
any | |
service_attributes |
object (free-form) | |
state |
any | |
vendor_details |
string | |
getting_started |
string | |
integration_guide |
string | |
thumbnail |
string (uri) | |
order_count |
integer | |
plans |
array of objects | |
plans.url |
string (uri) | |
plans.uuid |
string (uuid) | |
plans.name |
string | |
plans.description |
string | |
plans.article_code |
string | |
plans.max_amount |
integer | Maximum number of plans that could be active. Plan is disabled when maximum amount is reached. |
plans.archived |
boolean | Forbids creation of new resources. |
plans.is_active |
boolean | |
plans.unit_price |
string (decimal) | |
plans.unit |
string | Enum: month, quarter, half_month, day, hour, quantity |
plans.init_price |
number (double) | |
plans.switch_price |
number (double) | |
plans.backend_id |
string | |
plans.organization_groups |
array of objects | |
plans.organization_groups.uuid |
string (uuid) | |
plans.organization_groups.url |
string (uri) | |
plans.organization_groups.name |
string | |
plans.organization_groups.parent_uuid |
string (uuid) | UUID of the parent organization group |
plans.organization_groups.parent_name |
string | Name of the parent organization group |
plans.organization_groups.parent |
string (uri) | |
plans.organization_groups.customers_count |
integer | Number of customers in this organization group |
plans.components |
array of objects | |
plans.components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
plans.components.name |
string | Display name for the measured unit, for example, Floating IP. |
plans.components.measured_unit |
string | Unit of measurement, for example, GB. |
plans.components.amount |
integer | |
plans.components.price |
string (decimal) | |
plans.components.future_price |
string (decimal) | |
plans.components.discount_threshold |
integer | Minimum amount to be eligible for discount. |
plans.components.discount_rate |
integer | Discount rate in percentage. |
plans.prices |
object (free-form) | |
plans.future_prices |
object (free-form) | |
plans.quotas |
object (free-form) | |
plans.resources_count |
integer | |
plans.plan_type |
string | |
plans.minimal_price |
number (double) | |
screenshots |
array of objects | |
screenshots.name |
string | |
screenshots.uuid |
string (uuid) | |
screenshots.description |
string | |
screenshots.image |
string (uri) | |
screenshots.thumbnail |
string (uri) | |
screenshots.created |
string (date-time) | |
type |
string | |
shared |
boolean | Accessible to all customers. |
billable |
boolean | Purchase and usage is invoiced. |
scope |
string | |
scope_uuid |
string (uuid) | |
scope_name |
string (uuid) | |
scope_state |
any | |
scope_error_message |
string | |
files |
array of objects | |
files.name |
string | |
files.created |
string (date-time) | |
files.file |
string (uri) | |
quotas |
array of objects | |
quotas.name |
string | |
quotas.usage |
integer | |
quotas.limit |
integer | |
paused_reason |
string | |
datacite_doi |
string | |
citation_count |
integer | Number of citations of a DOI |
latitude |
number (double) | |
longitude |
number (double) | |
country |
any | Country code (ISO 3166-1 alpha-2) |
backend_id |
string | |
backend_id_rules |
any | Validation rules for resource backend_id: format regex and uniqueness scope. |
organization_groups |
array of objects | |
organization_groups.uuid |
string (uuid) | |
organization_groups.url |
string (uri) | |
organization_groups.name |
string | |
organization_groups.parent_uuid |
string (uuid) | UUID of the parent organization group |
organization_groups.parent_name |
string | Name of the parent organization group |
organization_groups.parent |
string (uri) | |
organization_groups.customers_count |
integer | Number of customers in this organization group |
tags |
array of objects | |
tags.uuid |
string (uuid) | |
tags.name |
string | |
image |
string (uri) | |
total_customers |
integer | |
total_cost |
integer | |
total_cost_estimated |
integer | |
parent_description |
string | |
parent_uuid |
string (uuid) | |
parent_name |
string | |
backend_metadata |
any | |
has_compliance_requirements |
boolean | |
billing_type_classification |
string | Classify offering components by billing type. Returns 'limit_only', 'usage_only', or 'mixed'. |
compliance_checklist |
string (uri) | |
integration_status |
array of objects | |
integration_status.agent_type |
any | |
integration_status.status |
string | |
integration_status.last_request_timestamp |
string (date-time) | |
integration_status.service_name |
string | |
google_calendar_is_public |
boolean | |
google_calendar_link |
string | Get the Google Calendar link for an offering. |
Retrieve a provider offering
Returns details of a specific provider offering.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
ProviderOfferingDetailsFieldEnum - API Source:
marketplace_provider_offerings_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
name |
string | |
slug |
string | URL-friendly identifier. Only editable by staff users. |
description |
string | |
full_description |
string | |
privacy_policy_link |
string (uri) | |
access_url |
string (uri) | Publicly accessible offering access URL |
endpoints |
array of objects | |
endpoints.uuid |
string (uuid) | |
endpoints.name |
string | |
endpoints.url |
string | URL of the access endpoint |
software_catalogs |
array of objects | |
software_catalogs.uuid |
string (uuid) | |
software_catalogs.catalog |
any | |
software_catalogs.enabled_cpu_family |
any | List of enabled CPU families: ['x86_64', 'aarch64'] |
software_catalogs.enabled_cpu_microarchitectures |
any | List of enabled CPU microarchitectures: ['generic', 'zen3'] |
software_catalogs.package_count |
integer | |
software_catalogs.partition |
any | |
partitions |
array of objects | |
partitions.uuid |
string (uuid) | |
partitions.partition_name |
string | Name of the SLURM partition |
partitions.cpu_bind |
integer | Default task binding policy (SLURM cpu_bind) |
partitions.def_cpu_per_gpu |
integer | Default CPUs allocated per GPU |
partitions.max_cpus_per_node |
integer | Maximum allocated CPUs per node |
partitions.max_cpus_per_socket |
integer | Maximum allocated CPUs per socket |
partitions.def_mem_per_cpu |
integer (int64) | Default memory per CPU in MB |
partitions.def_mem_per_gpu |
integer (int64) | Default memory per GPU in MB |
partitions.def_mem_per_node |
integer (int64) | Default memory per node in MB |
partitions.max_mem_per_cpu |
integer (int64) | Maximum memory per CPU in MB |
partitions.max_mem_per_node |
integer (int64) | Maximum memory per node in MB |
partitions.default_time |
integer | Default time limit in minutes |
partitions.max_time |
integer | Maximum time limit in minutes |
partitions.grace_time |
integer | Preemption grace time in seconds |
partitions.max_nodes |
integer | Maximum nodes per job |
partitions.min_nodes |
integer | Minimum nodes per job |
partitions.exclusive_topo |
boolean | Exclusive topology access required |
partitions.exclusive_user |
boolean | Exclusive user access required |
partitions.priority_tier |
integer | Priority tier for scheduling and preemption |
partitions.qos |
string | Quality of Service (QOS) name |
partitions.req_resv |
boolean | Require reservation for job allocation |
roles |
array of objects | |
roles.uuid |
string (uuid) | |
roles.name |
string | |
roles.url |
string (uri) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
project |
string (uri) | |
project_uuid |
string (uuid) | |
project_name |
string | |
category |
string (uri) | |
category_uuid |
string (uuid) | |
category_title |
string | |
attributes |
object (free-form) | |
options |
any | |
resource_options |
any | |
components |
array of objects | |
components.uuid |
string (uuid) | |
components.billing_type |
string | Enum: fixed, usage, limit, one, few |
components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
components.name |
string | Display name for the measured unit, for example, Floating IP. |
components.description |
string | |
components.measured_unit |
string | Unit of measurement, for example, GB. |
components.unit_factor |
integer | The conversion factor from backend units to measured_unit |
components.limit_period |
any | |
components.limit_amount |
integer | |
components.article_code |
string | |
components.max_value |
integer | |
components.min_value |
integer | |
components.max_available_limit |
integer | |
components.is_boolean |
boolean | |
components.default_limit |
integer | |
components.factor |
integer | |
components.is_builtin |
boolean | |
components.is_prepaid |
boolean | |
components.overage_component |
string (uuid) | |
components.min_prepaid_duration |
integer | |
components.max_prepaid_duration |
integer | |
plugin_options |
any | |
secret_options |
any | |
service_attributes |
object (free-form) | |
state |
any | |
vendor_details |
string | |
getting_started |
string | |
integration_guide |
string | |
thumbnail |
string (uri) | |
order_count |
integer | |
plans |
array of objects | |
plans.url |
string (uri) | |
plans.uuid |
string (uuid) | |
plans.name |
string | |
plans.description |
string | |
plans.article_code |
string | |
plans.max_amount |
integer | Maximum number of plans that could be active. Plan is disabled when maximum amount is reached. |
plans.archived |
boolean | Forbids creation of new resources. |
plans.is_active |
boolean | |
plans.unit_price |
string (decimal) | |
plans.unit |
string | Enum: month, quarter, half_month, day, hour, quantity |
plans.init_price |
number (double) | |
plans.switch_price |
number (double) | |
plans.backend_id |
string | |
plans.organization_groups |
array of objects | |
plans.organization_groups.uuid |
string (uuid) | |
plans.organization_groups.url |
string (uri) | |
plans.organization_groups.name |
string | |
plans.organization_groups.parent_uuid |
string (uuid) | UUID of the parent organization group |
plans.organization_groups.parent_name |
string | Name of the parent organization group |
plans.organization_groups.parent |
string (uri) | |
plans.organization_groups.customers_count |
integer | Number of customers in this organization group |
plans.components |
array of objects | |
plans.components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
plans.components.name |
string | Display name for the measured unit, for example, Floating IP. |
plans.components.measured_unit |
string | Unit of measurement, for example, GB. |
plans.components.amount |
integer | |
plans.components.price |
string (decimal) | |
plans.components.future_price |
string (decimal) | |
plans.components.discount_threshold |
integer | Minimum amount to be eligible for discount. |
plans.components.discount_rate |
integer | Discount rate in percentage. |
plans.prices |
object (free-form) | |
plans.future_prices |
object (free-form) | |
plans.quotas |
object (free-form) | |
plans.resources_count |
integer | |
plans.plan_type |
string | |
plans.minimal_price |
number (double) | |
screenshots |
array of objects | |
screenshots.name |
string | |
screenshots.uuid |
string (uuid) | |
screenshots.description |
string | |
screenshots.image |
string (uri) | |
screenshots.thumbnail |
string (uri) | |
screenshots.created |
string (date-time) | |
type |
string | |
shared |
boolean | Accessible to all customers. |
billable |
boolean | Purchase and usage is invoiced. |
scope |
string | |
scope_uuid |
string (uuid) | |
scope_name |
string (uuid) | |
scope_state |
any | |
scope_error_message |
string | |
files |
array of objects | |
files.name |
string | |
files.created |
string (date-time) | |
files.file |
string (uri) | |
quotas |
array of objects | |
quotas.name |
string | |
quotas.usage |
integer | |
quotas.limit |
integer | |
paused_reason |
string | |
datacite_doi |
string | |
citation_count |
integer | Number of citations of a DOI |
latitude |
number (double) | |
longitude |
number (double) | |
country |
any | Country code (ISO 3166-1 alpha-2) |
backend_id |
string | |
backend_id_rules |
any | Validation rules for resource backend_id: format regex and uniqueness scope. |
organization_groups |
array of objects | |
organization_groups.uuid |
string (uuid) | |
organization_groups.url |
string (uri) | |
organization_groups.name |
string | |
organization_groups.parent_uuid |
string (uuid) | UUID of the parent organization group |
organization_groups.parent_name |
string | Name of the parent organization group |
organization_groups.parent |
string (uri) | |
organization_groups.customers_count |
integer | Number of customers in this organization group |
tags |
array of objects | |
tags.uuid |
string (uuid) | |
tags.name |
string | |
image |
string (uri) | |
total_customers |
integer | |
total_cost |
integer | |
total_cost_estimated |
integer | |
parent_description |
string | |
parent_uuid |
string (uuid) | |
parent_name |
string | |
backend_metadata |
any | |
has_compliance_requirements |
boolean | |
billing_type_classification |
string | Classify offering components by billing type. Returns 'limit_only', 'usage_only', or 'mixed'. |
compliance_checklist |
string (uri) | |
integration_status |
array of objects | |
integration_status.agent_type |
any | |
integration_status.status |
string | |
integration_status.last_request_timestamp |
string (date-time) | |
integration_status.service_name |
string | |
google_calendar_is_public |
boolean | |
google_calendar_link |
string | Get the Google Calendar link for an offering. |
Create a provider offering
Creates a new provider offering.
1 2 3 4 5 6 7 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
OfferingCreateRequest - API Source:
marketplace_provider_offerings_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ✓ | |
slug |
string | URL-friendly identifier. Only editable by staff users. | |
description |
string | ||
full_description |
string | ||
privacy_policy_link |
string (uri) | ||
access_url |
string (uri) | Publicly accessible offering access URL | |
customer |
string (uri) | ||
category |
string (uri) | ✓ | |
attributes |
any | ||
options |
object | ||
options.order |
array of strings | ✓ | |
options.options |
object (free-form) | ✓ | |
resource_options |
object | ||
resource_options.order |
array of strings | ✓ | |
resource_options.options |
object (free-form) | ✓ | |
components |
array of objects | ||
components.billing_type |
string | ✓ | Enum: fixed, usage, limit, one, few |
components.type |
string | ✓ | Unique internal name of the measured unit, for example floating_ip. |
components.name |
string | ✓ | Display name for the measured unit, for example, Floating IP. |
components.description |
string | ||
components.measured_unit |
string | Unit of measurement, for example, GB. | |
components.unit_factor |
integer | The conversion factor from backend units to measured_unit | |
components.limit_period |
any | ||
components.limit_amount |
integer | ||
components.article_code |
string | ||
components.max_value |
integer | ||
components.min_value |
integer | ||
components.max_available_limit |
integer | ||
components.is_boolean |
boolean | ||
components.default_limit |
integer | ||
components.is_prepaid |
boolean | ||
components.overage_component |
string (uuid) | ||
components.min_prepaid_duration |
integer | ||
components.max_prepaid_duration |
integer | ||
plugin_options |
object | ||
plugin_options.auto_approve_remote_orders |
boolean | If set to True, an order can be processed without approval | |
plugin_options.resource_expiration_threshold |
integer | Resource expiration threshold in days. Constraints: default: 30 |
|
plugin_options.service_provider_can_create_offering_user |
boolean | Service provider can create offering user | |
plugin_options.max_resource_termination_offset_in_days |
integer | Maximum resource termination offset in days | |
plugin_options.default_resource_termination_offset_in_days |
integer | If set, it will be used as a default resource termination offset in days | |
plugin_options.is_resource_termination_date_required |
boolean | If set to True, resource termination date is required | |
plugin_options.latest_date_for_resource_termination |
string | If set, it will be used as a latest date for resource termination. Format: YYYY-MM-DD | |
plugin_options.auto_approve_in_service_provider_projects |
boolean | Skip approval of public offering belonging to the same organization under which the request is done | |
plugin_options.disable_autoapprove |
boolean | If set to True, orders for this offering will always require manual approval, overriding auto_approve_in_service_provider_projects | |
plugin_options.supports_downscaling |
boolean | If set to True, it will be possible to downscale resources | |
plugin_options.supports_pausing |
boolean | If set to True, it will be possible to pause resources | |
plugin_options.minimal_team_count_for_provisioning |
integer | Minimal team count required for provisioning of resources | |
plugin_options.maximal_resource_count_per_project |
integer | Maximal number of offering resources allowed per project | |
plugin_options.unique_resource_per_attribute |
string | Attribute name to enforce uniqueness per value. E.g., 'storage_data_type' ensures only one resource per storage type per project. | |
plugin_options.required_team_role_for_provisioning |
string | Required user role in a project for provisioning of resources | |
plugin_options.enable_purchase_order_upload |
boolean | If set to True, users will be able to upload purchase orders. | |
plugin_options.require_purchase_order_upload |
boolean | If set to True, users will be required to upload purchase orders. | |
plugin_options.conceal_billing_data |
boolean | If set to True, pricing and components tab would be concealed. | |
plugin_options.create_orders_on_resource_option_change |
boolean | If set to True, create orders when options of related resources are changed. | |
plugin_options.can_restore_resource |
boolean | If set to True, resource can be restored. | |
plugin_options.enable_provider_consumer_messaging |
boolean | If set to True, service providers can send messages with attachments to consumers on pending orders, and consumers can respond. | |
plugin_options.notify_about_provider_consumer_messages |
boolean | If set to True, send email notifications when providers or consumers exchange messages on pending orders. | |
plugin_options.restrict_deletion_with_active_resources |
boolean | If set to True, offering cannot be deleted while it has non-terminated resources. | |
plugin_options.resource_name_pattern |
string | Python format string for generating resource names. Available variables: {customer_name}, {customer_slug}, {project_name}, {project_slug}, {offering_name}, {offering_slug}, {plan_name}, {counter}, {attributes[KEY]}. | |
plugin_options.default_internal_network_mtu |
integer | If set, it will be used as a default MTU for the first network in a tenant | |
plugin_options.max_instances |
integer | Default limit for number of instances in OpenStack tenant | |
plugin_options.max_volumes |
integer | Default limit for number of volumes in OpenStack tenant | |
plugin_options.max_security_groups |
integer | Default limit for number of security groups in OpenStack tenant | |
plugin_options.storage_mode |
any | Storage mode for OpenStack offering | |
plugin_options.snapshot_size_limit_gb |
integer | Default limit for snapshot size in GB | |
plugin_options.heappe_cluster_id |
string | HEAppE cluster id | |
plugin_options.heappe_local_base_path |
string | HEAppE local base path | |
plugin_options.heappe_url |
string | HEAppE url | |
plugin_options.heappe_username |
string | HEAppE username | |
plugin_options.homedir_prefix |
string | GLAuth homedir prefix Constraints: default: /home/ |
|
plugin_options.scratch_project_directory |
string | HEAppE scratch project directory | |
plugin_options.project_permanent_directory |
string | HEAppE project permanent directory | |
plugin_options.initial_primarygroup_number |
integer | GLAuth initial primary group number Constraints: default: 5000 |
|
plugin_options.initial_uidnumber |
integer | GLAuth initial uidnumber Constraints: default: 5000 |
|
plugin_options.initial_usergroup_number |
integer | GLAuth initial usergroup number Constraints: default: 6000 |
|
plugin_options.username_anonymized_prefix |
string | GLAuth prefix for anonymized usernames Constraints: default: waldur_ |
|
plugin_options.username_generation_policy |
any | GLAuth username generation policy Constraints: default: service_provider |
|
plugin_options.enable_issues_for_membership_changes |
boolean | Enable issues for membership changes | |
plugin_options.deployment_mode |
any | Rancher deployment mode | |
plugin_options.flavors_regex |
string | Regular expression to limit flavors list | |
plugin_options.openstack_offering_uuid_list |
array of strings | List of UUID of OpenStack offerings where tenant can be created | |
plugin_options.managed_rancher_server_flavor_name |
string | Flavor name for managed Rancher server instances | |
plugin_options.managed_rancher_server_system_volume_size_gb |
integer | System volume size in GB for managed Rancher server | |
plugin_options.managed_rancher_server_system_volume_type_name |
string | System volume type name for managed Rancher server | |
plugin_options.managed_rancher_server_data_volume_size_gb |
integer | Data volume size in GB for managed Rancher server | |
plugin_options.managed_rancher_server_data_volume_type_name |
string | Data volume type name for managed Rancher server | |
plugin_options.managed_rancher_worker_system_volume_size_gb |
integer | System volume size in GB for managed Rancher worker nodes | |
plugin_options.managed_rancher_worker_system_volume_type_name |
string | System volume type name for managed Rancher worker nodes | |
plugin_options.managed_rancher_load_balancer_flavor_name |
string | Flavor name for managed Rancher load balancer | |
plugin_options.managed_rancher_load_balancer_system_volume_size_gb |
integer | System volume size in GB for managed Rancher load balancer | |
plugin_options.managed_rancher_load_balancer_system_volume_type_name |
string | System volume type name for managed Rancher load balancer | |
plugin_options.managed_rancher_load_balancer_data_volume_size_gb |
integer | Data volume size in GB for managed Rancher load balancer | |
plugin_options.managed_rancher_load_balancer_data_volume_type_name |
string | Data volume type name for managed Rancher load balancer | |
plugin_options.managed_rancher_tenant_max_cpu |
integer | Max number of vCPUs for tenants | |
plugin_options.managed_rancher_tenant_max_ram |
integer | Max number of RAM for tenants (GB) | |
plugin_options.managed_rancher_tenant_max_disk |
integer | Max size of disk space for tenants (GB) | |
plugin_options.account_name_generation_policy |
any | Slurm account name generation policy | |
plugin_options.enable_display_of_order_actions_for_service_provider |
boolean | Enable display of order actions for service provider Constraints: default: True |
|
plugin_options.slurm_periodic_policy_enabled |
boolean | Enable SLURM periodic usage policy configuration. When enabled, allows configuring QoS-based threshold enforcement, carryover logic, and fairshare decay for site-agent managed SLURM offerings. Constraints: default: False |
|
plugin_options.auto_approve_marketplace_script |
boolean | If set to False, all orders require manual provider approval, including for service provider owners and staff Constraints: default: True |
|
plugin_options.keycloak_enabled |
boolean | If set to True, Keycloak group management is enabled for this offering. | |
plugin_options.keycloak_base_group |
string | Root parent group in Keycloak under which offering groups are created. Groups are organized as: {base_group}/{offering_slug}/{role_group}. If empty, offering groups are created at the realm root. | |
plugin_options.keycloak_sync_frequency |
integer | Frequency in minutes for syncing Keycloak group memberships. | |
plugin_options.keycloak_group_name_template |
string | Template for generating Keycloak group names. Uses $variable syntax (e.g. $offering_uuid_$role_name). Allowed variables: offering_uuid, offering_name, offering_slug, resource_uuid, resource_name, resource_slug, project_uuid, project_name, project_slug, organization_uuid, organization_name, organization_slug, role_name, scope_id. | |
plugin_options.keycloak_username_label |
string | Custom label for the username field when inviting external users (e.g. 'Civil code', 'CUID'). If empty, defaults to 'Username'. Constraints: default: `` |
|
plugin_options.highlight_backend_id_display |
boolean | Defines if backend_id should be shown more prominently by the UI Constraints: default: False |
|
plugin_options.backend_id_display_label |
string | Label used by UI for showing value of the backend_id Constraints: default: Backend ID |
|
plugin_options.disabled_resource_actions |
array of strings | List of disabled marketplace resource actions for this offering. | |
vendor_details |
string | ||
getting_started |
string | ||
integration_guide |
string | ||
thumbnail |
string (binary) | ||
plans |
array of objects | ||
plans.name |
string | ✓ | |
plans.description |
string | ||
plans.article_code |
string | ||
plans.max_amount |
integer | Maximum number of plans that could be active. Plan is disabled when maximum amount is reached. | |
plans.archived |
boolean | Forbids creation of new resources. | |
plans.unit_price |
string (decimal) | ||
plans.unit |
string | Enum: month, quarter, half_month, day, hour, quantity |
|
plans.backend_id |
string | ||
type |
string | ✓ | |
shared |
boolean | Accessible to all customers. | |
billable |
boolean | Purchase and usage is invoiced. | |
datacite_doi |
string | ||
latitude |
number (double) | ||
longitude |
number (double) | ||
country |
any | Country code (ISO 3166-1 alpha-2) | |
backend_id |
string | ||
backend_id_rules |
any | Validation rules for resource backend_id: format regex and uniqueness scope. | |
image |
string (binary) | ||
backend_metadata |
any | ||
compliance_checklist |
string (uri) | ||
limits |
object (free-form) | Constraints: write-only |
201 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
name |
string | |
slug |
string | URL-friendly identifier. Only editable by staff users. |
description |
string | |
full_description |
string | |
privacy_policy_link |
string (uri) | |
access_url |
string (uri) | Publicly accessible offering access URL |
endpoints |
array of objects | |
endpoints.uuid |
string (uuid) | |
endpoints.name |
string | |
endpoints.url |
string | URL of the access endpoint |
software_catalogs |
array of objects | |
software_catalogs.uuid |
string (uuid) | |
software_catalogs.catalog |
any | |
software_catalogs.enabled_cpu_family |
any | List of enabled CPU families: ['x86_64', 'aarch64'] |
software_catalogs.enabled_cpu_microarchitectures |
any | List of enabled CPU microarchitectures: ['generic', 'zen3'] |
software_catalogs.package_count |
integer | |
software_catalogs.partition |
any | |
partitions |
array of objects | |
partitions.uuid |
string (uuid) | |
partitions.partition_name |
string | Name of the SLURM partition |
partitions.cpu_bind |
integer | Default task binding policy (SLURM cpu_bind) |
partitions.def_cpu_per_gpu |
integer | Default CPUs allocated per GPU |
partitions.max_cpus_per_node |
integer | Maximum allocated CPUs per node |
partitions.max_cpus_per_socket |
integer | Maximum allocated CPUs per socket |
partitions.def_mem_per_cpu |
integer (int64) | Default memory per CPU in MB |
partitions.def_mem_per_gpu |
integer (int64) | Default memory per GPU in MB |
partitions.def_mem_per_node |
integer (int64) | Default memory per node in MB |
partitions.max_mem_per_cpu |
integer (int64) | Maximum memory per CPU in MB |
partitions.max_mem_per_node |
integer (int64) | Maximum memory per node in MB |
partitions.default_time |
integer | Default time limit in minutes |
partitions.max_time |
integer | Maximum time limit in minutes |
partitions.grace_time |
integer | Preemption grace time in seconds |
partitions.max_nodes |
integer | Maximum nodes per job |
partitions.min_nodes |
integer | Minimum nodes per job |
partitions.exclusive_topo |
boolean | Exclusive topology access required |
partitions.exclusive_user |
boolean | Exclusive user access required |
partitions.priority_tier |
integer | Priority tier for scheduling and preemption |
partitions.qos |
string | Quality of Service (QOS) name |
partitions.req_resv |
boolean | Require reservation for job allocation |
roles |
array of objects | |
roles.uuid |
string (uuid) | |
roles.name |
string | |
roles.url |
string (uri) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
project |
string (uri) | |
project_uuid |
string (uuid) | |
project_name |
string | |
category |
string (uri) | |
category_uuid |
string (uuid) | |
category_title |
string | |
attributes |
object (free-form) | |
options |
any | |
resource_options |
any | |
components |
array of objects | |
components.uuid |
string (uuid) | |
components.billing_type |
string | Enum: fixed, usage, limit, one, few |
components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
components.name |
string | Display name for the measured unit, for example, Floating IP. |
components.description |
string | |
components.measured_unit |
string | Unit of measurement, for example, GB. |
components.unit_factor |
integer | The conversion factor from backend units to measured_unit |
components.limit_period |
any | |
components.limit_amount |
integer | |
components.article_code |
string | |
components.max_value |
integer | |
components.min_value |
integer | |
components.max_available_limit |
integer | |
components.is_boolean |
boolean | |
components.default_limit |
integer | |
components.factor |
integer | |
components.is_builtin |
boolean | |
components.is_prepaid |
boolean | |
components.overage_component |
string (uuid) | |
components.min_prepaid_duration |
integer | |
components.max_prepaid_duration |
integer | |
plugin_options |
any | |
secret_options |
any | |
service_attributes |
object (free-form) | |
state |
any | |
vendor_details |
string | |
getting_started |
string | |
integration_guide |
string | |
thumbnail |
string (uri) | |
order_count |
integer | |
plans |
array of objects | |
plans.url |
string (uri) | |
plans.uuid |
string (uuid) | |
plans.name |
string | |
plans.description |
string | |
plans.article_code |
string | |
plans.max_amount |
integer | Maximum number of plans that could be active. Plan is disabled when maximum amount is reached. |
plans.archived |
boolean | Forbids creation of new resources. |
plans.is_active |
boolean | |
plans.unit_price |
string (decimal) | |
plans.unit |
string | Enum: month, quarter, half_month, day, hour, quantity |
plans.init_price |
number (double) | |
plans.switch_price |
number (double) | |
plans.backend_id |
string | |
plans.organization_groups |
array of objects | |
plans.organization_groups.uuid |
string (uuid) | |
plans.organization_groups.url |
string (uri) | |
plans.organization_groups.name |
string | |
plans.organization_groups.parent_uuid |
string (uuid) | UUID of the parent organization group |
plans.organization_groups.parent_name |
string | Name of the parent organization group |
plans.organization_groups.parent |
string (uri) | |
plans.organization_groups.customers_count |
integer | Number of customers in this organization group |
plans.components |
array of objects | |
plans.components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
plans.components.name |
string | Display name for the measured unit, for example, Floating IP. |
plans.components.measured_unit |
string | Unit of measurement, for example, GB. |
plans.components.amount |
integer | |
plans.components.price |
string (decimal) | |
plans.components.future_price |
string (decimal) | |
plans.components.discount_threshold |
integer | Minimum amount to be eligible for discount. |
plans.components.discount_rate |
integer | Discount rate in percentage. |
plans.prices |
object (free-form) | |
plans.future_prices |
object (free-form) | |
plans.quotas |
object (free-form) | |
plans.resources_count |
integer | |
plans.plan_type |
string | |
plans.minimal_price |
number (double) | |
screenshots |
array of objects | |
screenshots.name |
string | |
screenshots.uuid |
string (uuid) | |
screenshots.description |
string | |
screenshots.image |
string (uri) | |
screenshots.thumbnail |
string (uri) | |
screenshots.created |
string (date-time) | |
type |
string | |
shared |
boolean | Accessible to all customers. |
billable |
boolean | Purchase and usage is invoiced. |
scope |
string | |
scope_uuid |
string (uuid) | |
scope_name |
string (uuid) | |
scope_state |
any | |
scope_error_message |
string | |
files |
array of objects | |
files.name |
string | |
files.created |
string (date-time) | |
files.file |
string (uri) | |
quotas |
array of objects | |
quotas.name |
string | |
quotas.usage |
integer | |
quotas.limit |
integer | |
paused_reason |
string | |
datacite_doi |
string | |
citation_count |
integer | Number of citations of a DOI |
latitude |
number (double) | |
longitude |
number (double) | |
country |
any | Country code (ISO 3166-1 alpha-2) |
backend_id |
string | |
backend_id_rules |
any | Validation rules for resource backend_id: format regex and uniqueness scope. |
organization_groups |
array of objects | |
organization_groups.uuid |
string (uuid) | |
organization_groups.url |
string (uri) | |
organization_groups.name |
string | |
organization_groups.parent_uuid |
string (uuid) | UUID of the parent organization group |
organization_groups.parent_name |
string | Name of the parent organization group |
organization_groups.parent |
string (uri) | |
organization_groups.customers_count |
integer | Number of customers in this organization group |
tags |
array of objects | |
tags.uuid |
string (uuid) | |
tags.name |
string | |
image |
string (uri) | |
total_customers |
integer | |
total_cost |
integer | |
total_cost_estimated |
integer | |
parent_description |
string | |
parent_uuid |
string (uuid) | |
parent_name |
string | |
backend_metadata |
any | |
has_compliance_requirements |
boolean | |
billing_type_classification |
string | Classify offering components by billing type. Returns 'limit_only', 'usage_only', or 'mixed'. |
compliance_checklist |
string (uri) | |
integration_status |
array of objects | |
integration_status.agent_type |
any | |
integration_status.status |
string | |
integration_status.last_request_timestamp |
string (date-time) | |
integration_status.service_name |
string | |
google_calendar_is_public |
boolean | |
google_calendar_link |
string | Get the Google Calendar link for an offering. |
Delete a provider offering
Deletes a provider offering. Only possible for offerings in a Draft state with no associated resources.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_provider_offerings_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
State Management
Activate an offering
Activates a draft or paused offering, making it available for ordering.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_provider_offerings_activate
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
detail |
string |
state |
string |
Archive an offering
Archives an offering, making it permanently unavailable for new orders.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_provider_offerings_archive
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
detail |
string |
state |
string |
Move an offering to draft
Moves an active or paused offering back to the draft state for editing.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_provider_offerings_draft
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
detail |
string |
state |
string |
Pause an offering
Pauses an active offering, preventing new orders from being created.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
OfferingPauseRequest - API Source:
marketplace_provider_offerings_pause
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
paused_reason |
string |
200 -
| Field | Type |
|---|---|
detail |
string |
state |
string |
Unpause an offering
Resumes a paused offering, making it available for ordering again.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_provider_offerings_unpause
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
detail |
string |
state |
string |
Users and Accounts
Get GLauth user configuration
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
List course accounts for an offering
Returns a paginated list of course accounts for projects that have resources of this offering.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
- Model Source:
OfferingState - Model Source:
ProviderOfferingDetailsOEnum - API Source:
marketplace_provider_offerings_list_course_accounts_list
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
accessible_via_calls |
boolean | Accessible via calls |
allowed_customer_uuid |
string (uuid) | Allowed customer UUID |
attributes |
string | Offering attributes (JSON) |
billable |
boolean | Billable |
can_create_offering_user |
boolean | |
category_group_uuid |
string (uuid) | Category group UUID |
category_uuid |
string (uuid) | Category UUID |
created |
string (date-time) | Created after |
customer |
string (uri) | Customer URL |
customer_uuid |
string (uuid) | Customer UUID |
description |
string | Description contains |
has_active_terms_of_service |
boolean | Has Active Terms of Service |
has_terms_of_service |
boolean | Has Terms of Service |
importable |
string | Filter by importable offerings. |
keyword |
string | Keyword |
modified |
string (date-time) | Modified after |
name |
string | Name |
name_exact |
string | Name (exact) |
o |
array | Ordering |
organization_group_uuid |
string (uuid) | Organization group UUID |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
parent_uuid |
string (uuid) | Parent offering UUID |
project_uuid |
string (uuid) | Project UUID |
query |
string | Search by offering name, slug or description |
resource_customer_uuid |
string (uuid) | Resource customer UUID |
resource_project_uuid |
string (uuid) | Resource project UUID |
scope_uuid |
string | Scope UUID |
service_manager_uuid |
string (uuid) | Service manager UUID |
shared |
boolean | Shared |
state |
array | Offering state |
tag |
array | Tag UUID (OR logic) |
tag_name |
array | Tag name (OR logic) |
tag_names_and |
string | Tag names with AND logic (comma-separated) |
tags_and |
string | Tag UUIDs with AND logic (comma-separated) |
type |
array | Offering type |
user_has_consent |
boolean | User Has Consent |
user_has_offering_user |
boolean | User Has Offering User |
uuid_list |
string | Comma-separated offering UUIDs |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
created |
string (date-time) |
modified |
string (date-time) |
project |
string (uuid) |
project_uuid |
string (uuid) |
project_name |
string |
project_slug |
string |
project_start_date |
string (date) |
project_end_date |
string (date) |
user_uuid |
string (uuid) |
username |
string |
customer_uuid |
string (uuid) |
customer_name |
string |
state |
any |
email |
string (email) |
description |
string |
error_message |
string |
error_traceback |
string |
List customer service accounts for an offering
Returns a paginated list of customer-level service accounts for customers who have resources of this offering.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
- Model Source:
OfferingState - Model Source:
ProviderOfferingDetailsOEnum - API Source:
marketplace_provider_offerings_list_customer_service_accounts_list
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
accessible_via_calls |
boolean | Accessible via calls |
allowed_customer_uuid |
string (uuid) | Allowed customer UUID |
attributes |
string | Offering attributes (JSON) |
billable |
boolean | Billable |
can_create_offering_user |
boolean | |
category_group_uuid |
string (uuid) | Category group UUID |
category_uuid |
string (uuid) | Category UUID |
created |
string (date-time) | Created after |
customer |
string (uri) | Customer URL |
customer_uuid |
string (uuid) | Customer UUID |
description |
string | Description contains |
has_active_terms_of_service |
boolean | Has Active Terms of Service |
has_terms_of_service |
boolean | Has Terms of Service |
importable |
string | Filter by importable offerings. |
keyword |
string | Keyword |
modified |
string (date-time) | Modified after |
name |
string | Name |
name_exact |
string | Name (exact) |
o |
array | Ordering |
organization_group_uuid |
string (uuid) | Organization group UUID |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
parent_uuid |
string (uuid) | Parent offering UUID |
project_uuid |
string (uuid) | Project UUID |
query |
string | Search by offering name, slug or description |
resource_customer_uuid |
string (uuid) | Resource customer UUID |
resource_project_uuid |
string (uuid) | Resource project UUID |
scope_uuid |
string | Scope UUID |
service_manager_uuid |
string (uuid) | Service manager UUID |
shared |
boolean | Shared |
state |
array | Offering state |
tag |
array | Tag UUID (OR logic) |
tag_name |
array | Tag name (OR logic) |
tag_names_and |
string | Tag names with AND logic (comma-separated) |
tags_and |
string | Tag UUIDs with AND logic (comma-separated) |
type |
array | Offering type |
user_has_consent |
boolean | User Has Consent |
user_has_offering_user |
boolean | User Has Offering User |
uuid_list |
string | Comma-separated offering UUIDs |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
created |
string (date-time) |
modified |
string (date-time) |
username |
string |
description |
string |
error_message |
string |
error_traceback |
string |
state |
any |
token |
string |
email |
string (email) |
expires_at |
string |
preferred_identifier |
string |
customer |
string (uuid) |
customer_uuid |
string (uuid) |
customer_name |
string |
List customer users for an offering
Returns a paginated list of users who have access to resources of this offering.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
- Model Source:
UserFieldEnum - API Source:
marketplace_provider_offerings_list_customer_users_list
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
field |
array | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
slug |
string | URL-friendly identifier. Only editable by staff users. |
full_name |
string | |
native_name |
string | |
job_title |
string | |
email |
string (email) | |
phone_number |
string | |
organization |
string | |
civil_number |
string | |
description |
string | |
is_staff |
boolean | Designates whether the user can log into this admin site. |
is_active |
boolean | Designates whether this user should be treated as active. Unselect this instead of deleting accounts. |
is_support |
boolean | Designates whether the user is a global support user. |
token |
string | |
token_lifetime |
integer | Token lifetime in seconds. |
token_expires_at |
string (date-time) | |
registration_method |
string | Indicates what registration method was used. |
date_joined |
string (date-time) | |
agreement_date |
string (date-time) | Indicates when the user has agreed with the policy. |
notifications_enabled |
boolean | Designates whether the user is allowed to receive email notifications. |
preferred_language |
string | |
permissions |
array of objects | |
permissions.user_uuid |
string (uuid) | |
permissions.user_name |
string | |
permissions.user_slug |
string | |
permissions.created |
string (date-time) | |
permissions.expiration_time |
string (date-time) | |
permissions.created_by_full_name |
string | |
permissions.created_by_username |
string | |
permissions.role_name |
string | |
permissions.role_description |
string | |
permissions.role_uuid |
string (uuid) | |
permissions.scope_type |
string | |
permissions.scope_uuid |
string (uuid) | |
permissions.scope_name |
string | |
permissions.customer_uuid |
string (uuid) | |
permissions.customer_name |
string | |
requested_email |
string | |
affiliations |
any | Person's affiliation within organization such as student, faculty, staff. |
first_name |
string | |
last_name |
string | |
birth_date |
string (date) | |
identity_provider_name |
string | |
identity_provider_label |
string | |
identity_provider_management_url |
string | |
identity_provider_fields |
array of strings | |
image |
string (uri) | |
identity_source |
string | Indicates what identity provider was used. |
has_active_session |
boolean | |
ip_address |
string | |
gender |
any | ISO 5218 gender code |
personal_title |
string | Honorific title (Mr, Ms, Dr, Prof, etc.) |
place_of_birth |
string | |
country_of_residence |
string | |
nationality |
string | Primary citizenship (ISO 3166-1 alpha-2 code) |
nationalities |
any | List of all citizenships (ISO 3166-1 alpha-2 codes) |
organization_country |
string | |
organization_type |
string | SCHAC URN (e.g., urn:schac:homeOrganizationType:int:university) |
organization_registry_code |
string | Company registration code of the user's organization, if known |
eduperson_assurance |
any | REFEDS assurance profile URIs from identity provider |
is_identity_manager |
boolean | Designates whether the user is allowed to manage remote user identities. |
attribute_sources |
any | Per-attribute source and freshness tracking. Format: {'field_name': {'source': 'isd: |
managed_isds |
any | List of ISD source identifiers this user can manage via Identity Bridge. E.g., ['isd:puhuri', 'isd:fenix']. Non-empty list implies identity manager role. |
active_isds |
any | List of ISDs that have asserted this user exists. User is deactivated when this becomes empty. |
List project service accounts for an offering
Returns a paginated list of project-level service accounts for projects that have resources of this offering.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
- Model Source:
OfferingState - Model Source:
ProviderOfferingDetailsOEnum - API Source:
marketplace_provider_offerings_list_project_service_accounts_list
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
accessible_via_calls |
boolean | Accessible via calls |
allowed_customer_uuid |
string (uuid) | Allowed customer UUID |
attributes |
string | Offering attributes (JSON) |
billable |
boolean | Billable |
can_create_offering_user |
boolean | |
category_group_uuid |
string (uuid) | Category group UUID |
category_uuid |
string (uuid) | Category UUID |
created |
string (date-time) | Created after |
customer |
string (uri) | Customer URL |
customer_uuid |
string (uuid) | Customer UUID |
description |
string | Description contains |
has_active_terms_of_service |
boolean | Has Active Terms of Service |
has_terms_of_service |
boolean | Has Terms of Service |
importable |
string | Filter by importable offerings. |
keyword |
string | Keyword |
modified |
string (date-time) | Modified after |
name |
string | Name |
name_exact |
string | Name (exact) |
o |
array | Ordering |
organization_group_uuid |
string (uuid) | Organization group UUID |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
parent_uuid |
string (uuid) | Parent offering UUID |
project_uuid |
string (uuid) | Project UUID |
query |
string | Search by offering name, slug or description |
resource_customer_uuid |
string (uuid) | Resource customer UUID |
resource_project_uuid |
string (uuid) | Resource project UUID |
scope_uuid |
string | Scope UUID |
service_manager_uuid |
string (uuid) | Service manager UUID |
shared |
boolean | Shared |
state |
array | Offering state |
tag |
array | Tag UUID (OR logic) |
tag_name |
array | Tag name (OR logic) |
tag_names_and |
string | Tag names with AND logic (comma-separated) |
tags_and |
string | Tag UUIDs with AND logic (comma-separated) |
type |
array | Offering type |
user_has_consent |
boolean | User Has Consent |
user_has_offering_user |
boolean | User Has Offering User |
uuid_list |
string | Comma-separated offering UUIDs |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
created |
string (date-time) |
modified |
string (date-time) |
username |
string |
description |
string |
error_message |
string |
error_traceback |
string |
state |
any |
token |
string |
email |
string (email) |
expires_at |
string |
preferred_identifier |
string |
project |
string (uuid) |
project_uuid |
string (uuid) |
project_name |
string |
customer_uuid |
string (uuid) |
customer_name |
string |
customer_abbreviation |
string |
List users and their roles in a scope
Retrieves a list of users who have a role within a specific scope (e.g., a project or an organization). The list can be filtered by user details or role.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
- Model Source:
UserRoleDetailsFieldEnum - Model Source:
UserRoleDetailsOEnum - API Source:
marketplace_provider_offerings_list_users_list
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
field |
array | Fields to include in response |
full_name |
string | User full name |
native_name |
string | User native name |
o |
array | Ordering fields |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
role |
string (uuid) | Role UUID or name |
search_string |
string | Search string for user |
user |
string (uuid) | User UUID |
user_slug |
string | User slug |
user_url |
string | User URL |
username |
string | User username |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
created |
string (date-time) | |
expiration_time |
string (date-time) | |
role_name |
string | |
role_uuid |
string (uuid) | |
user_email |
string (email) | |
user_full_name |
string | |
user_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
user_uuid |
string (uuid) | |
user_image |
string (uri) | |
created_by_full_name |
string | |
created_by_uuid |
string (uuid) |
Check user access to offering resources
Checks if a specified user has access to any non-terminated resource of this offering.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
- Model Source:
ProviderOfferingDetailsFieldEnum - API Source:
marketplace_provider_offerings_user_has_resource_access_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Required | Description |
|---|---|---|---|
field |
array | ||
username |
string | ✓ | Username of the user to check. |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
name |
string | |
slug |
string | URL-friendly identifier. Only editable by staff users. |
description |
string | |
full_description |
string | |
privacy_policy_link |
string (uri) | |
access_url |
string (uri) | Publicly accessible offering access URL |
endpoints |
array of objects | |
endpoints.uuid |
string (uuid) | |
endpoints.name |
string | |
endpoints.url |
string | URL of the access endpoint |
software_catalogs |
array of objects | |
software_catalogs.uuid |
string (uuid) | |
software_catalogs.catalog |
any | |
software_catalogs.enabled_cpu_family |
any | List of enabled CPU families: ['x86_64', 'aarch64'] |
software_catalogs.enabled_cpu_microarchitectures |
any | List of enabled CPU microarchitectures: ['generic', 'zen3'] |
software_catalogs.package_count |
integer | |
software_catalogs.partition |
any | |
partitions |
array of objects | |
partitions.uuid |
string (uuid) | |
partitions.partition_name |
string | Name of the SLURM partition |
partitions.cpu_bind |
integer | Default task binding policy (SLURM cpu_bind) |
partitions.def_cpu_per_gpu |
integer | Default CPUs allocated per GPU |
partitions.max_cpus_per_node |
integer | Maximum allocated CPUs per node |
partitions.max_cpus_per_socket |
integer | Maximum allocated CPUs per socket |
partitions.def_mem_per_cpu |
integer (int64) | Default memory per CPU in MB |
partitions.def_mem_per_gpu |
integer (int64) | Default memory per GPU in MB |
partitions.def_mem_per_node |
integer (int64) | Default memory per node in MB |
partitions.max_mem_per_cpu |
integer (int64) | Maximum memory per CPU in MB |
partitions.max_mem_per_node |
integer (int64) | Maximum memory per node in MB |
partitions.default_time |
integer | Default time limit in minutes |
partitions.max_time |
integer | Maximum time limit in minutes |
partitions.grace_time |
integer | Preemption grace time in seconds |
partitions.max_nodes |
integer | Maximum nodes per job |
partitions.min_nodes |
integer | Minimum nodes per job |
partitions.exclusive_topo |
boolean | Exclusive topology access required |
partitions.exclusive_user |
boolean | Exclusive user access required |
partitions.priority_tier |
integer | Priority tier for scheduling and preemption |
partitions.qos |
string | Quality of Service (QOS) name |
partitions.req_resv |
boolean | Require reservation for job allocation |
roles |
array of objects | |
roles.uuid |
string (uuid) | |
roles.name |
string | |
roles.url |
string (uri) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
project |
string (uri) | |
project_uuid |
string (uuid) | |
project_name |
string | |
category |
string (uri) | |
category_uuid |
string (uuid) | |
category_title |
string | |
attributes |
object (free-form) | |
options |
any | |
resource_options |
any | |
components |
array of objects | |
components.uuid |
string (uuid) | |
components.billing_type |
string | Enum: fixed, usage, limit, one, few |
components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
components.name |
string | Display name for the measured unit, for example, Floating IP. |
components.description |
string | |
components.measured_unit |
string | Unit of measurement, for example, GB. |
components.unit_factor |
integer | The conversion factor from backend units to measured_unit |
components.limit_period |
any | |
components.limit_amount |
integer | |
components.article_code |
string | |
components.max_value |
integer | |
components.min_value |
integer | |
components.max_available_limit |
integer | |
components.is_boolean |
boolean | |
components.default_limit |
integer | |
components.factor |
integer | |
components.is_builtin |
boolean | |
components.is_prepaid |
boolean | |
components.overage_component |
string (uuid) | |
components.min_prepaid_duration |
integer | |
components.max_prepaid_duration |
integer | |
plugin_options |
any | |
secret_options |
any | |
service_attributes |
object (free-form) | |
state |
any | |
vendor_details |
string | |
getting_started |
string | |
integration_guide |
string | |
thumbnail |
string (uri) | |
order_count |
integer | |
plans |
array of objects | |
plans.url |
string (uri) | |
plans.uuid |
string (uuid) | |
plans.name |
string | |
plans.description |
string | |
plans.article_code |
string | |
plans.max_amount |
integer | Maximum number of plans that could be active. Plan is disabled when maximum amount is reached. |
plans.archived |
boolean | Forbids creation of new resources. |
plans.is_active |
boolean | |
plans.unit_price |
string (decimal) | |
plans.unit |
string | Enum: month, quarter, half_month, day, hour, quantity |
plans.init_price |
number (double) | |
plans.switch_price |
number (double) | |
plans.backend_id |
string | |
plans.organization_groups |
array of objects | |
plans.organization_groups.uuid |
string (uuid) | |
plans.organization_groups.url |
string (uri) | |
plans.organization_groups.name |
string | |
plans.organization_groups.parent_uuid |
string (uuid) | UUID of the parent organization group |
plans.organization_groups.parent_name |
string | Name of the parent organization group |
plans.organization_groups.parent |
string (uri) | |
plans.organization_groups.customers_count |
integer | Number of customers in this organization group |
plans.components |
array of objects | |
plans.components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
plans.components.name |
string | Display name for the measured unit, for example, Floating IP. |
plans.components.measured_unit |
string | Unit of measurement, for example, GB. |
plans.components.amount |
integer | |
plans.components.price |
string (decimal) | |
plans.components.future_price |
string (decimal) | |
plans.components.discount_threshold |
integer | Minimum amount to be eligible for discount. |
plans.components.discount_rate |
integer | Discount rate in percentage. |
plans.prices |
object (free-form) | |
plans.future_prices |
object (free-form) | |
plans.quotas |
object (free-form) | |
plans.resources_count |
integer | |
plans.plan_type |
string | |
plans.minimal_price |
number (double) | |
screenshots |
array of objects | |
screenshots.name |
string | |
screenshots.uuid |
string (uuid) | |
screenshots.description |
string | |
screenshots.image |
string (uri) | |
screenshots.thumbnail |
string (uri) | |
screenshots.created |
string (date-time) | |
type |
string | |
shared |
boolean | Accessible to all customers. |
billable |
boolean | Purchase and usage is invoiced. |
scope |
string | |
scope_uuid |
string (uuid) | |
scope_name |
string (uuid) | |
scope_state |
any | |
scope_error_message |
string | |
files |
array of objects | |
files.name |
string | |
files.created |
string (date-time) | |
files.file |
string (uri) | |
quotas |
array of objects | |
quotas.name |
string | |
quotas.usage |
integer | |
quotas.limit |
integer | |
paused_reason |
string | |
datacite_doi |
string | |
citation_count |
integer | Number of citations of a DOI |
latitude |
number (double) | |
longitude |
number (double) | |
country |
any | Country code (ISO 3166-1 alpha-2) |
backend_id |
string | |
backend_id_rules |
any | Validation rules for resource backend_id: format regex and uniqueness scope. |
organization_groups |
array of objects | |
organization_groups.uuid |
string (uuid) | |
organization_groups.url |
string (uri) | |
organization_groups.name |
string | |
organization_groups.parent_uuid |
string (uuid) | UUID of the parent organization group |
organization_groups.parent_name |
string | Name of the parent organization group |
organization_groups.parent |
string (uri) | |
organization_groups.customers_count |
integer | Number of customers in this organization group |
tags |
array of objects | |
tags.uuid |
string (uuid) | |
tags.name |
string | |
image |
string (uri) | |
total_customers |
integer | |
total_cost |
integer | |
total_cost_estimated |
integer | |
parent_description |
string | |
parent_uuid |
string (uuid) | |
parent_name |
string | |
backend_metadata |
any | |
has_compliance_requirements |
boolean | |
billing_type_classification |
string | Classify offering components by billing type. Returns 'limit_only', 'usage_only', or 'mixed'. |
compliance_checklist |
string (uri) | |
integration_status |
array of objects | |
integration_status.agent_type |
any | |
integration_status.status |
string | |
integration_status.last_request_timestamp |
string (date-time) | |
integration_status.service_name |
string | |
google_calendar_is_public |
boolean | |
google_calendar_link |
string | Get the Google Calendar link for an offering. |
Grant a role to a user
Assigns a specific role to a user within the current scope. An optional expiration time for the role can be set.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
UserRoleCreateRequest - API Source:
marketplace_provider_offerings_add_user
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
role |
string | ✓ |
user |
string (uuid) | ✓ |
expiration_time |
string (date-time) |
201 -
| Field | Type |
|---|---|
expiration_time |
string (date-time) |
400 - Validation error, for example when trying to add a user to a terminated project.
Revoke a role from a user
Removes a specific role from a user within the current scope. This effectively revokes their permissions associated with that role.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
UserRoleDeleteRequest - API Source:
marketplace_provider_offerings_delete_user
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
role |
string | ✓ |
user |
string (uuid) | ✓ |
expiration_time |
string (date-time) |
200 - Role revoked successfully.
Refresh offering user usernames
Triggers a refresh of usernames for all non-restricted users associated with this offering, based on the current username generation policy.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
status |
string | Status of the resource response |
Update a user's role expiration
Updates the expiration time for a user's existing role in the current scope. This is useful for extending or shortening the duration of a permission. To make a role permanent, set expiration_time to null.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
UserRoleUpdateRequest - API Source:
marketplace_provider_offerings_update_user
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
role |
string | ✓ |
user |
string (uuid) | ✓ |
expiration_time |
string (date-time) |
200 -
| Field | Type |
|---|---|
expiration_time |
string (date-time) |
Update user attribute config
Creates or updates the user attribute configuration for this offering. This determines which user attributes are shared with the service provider.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
OfferingUserAttributeConfigRequest - API Source:
marketplace_provider_offerings_update_user_attribute_config
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
offering |
string (uuid) | |
expose_username |
boolean | |
expose_full_name |
boolean | |
expose_email |
boolean | |
expose_phone_number |
boolean | |
expose_organization |
boolean | |
expose_job_title |
boolean | |
expose_affiliations |
boolean | |
expose_gender |
boolean | |
expose_personal_title |
boolean | |
expose_place_of_birth |
boolean | |
expose_country_of_residence |
boolean | |
expose_nationality |
boolean | |
expose_nationalities |
boolean | |
expose_organization_country |
boolean | |
expose_organization_type |
boolean | |
expose_organization_registry_code |
boolean | |
expose_eduperson_assurance |
boolean | |
expose_civil_number |
boolean | |
expose_birth_date |
boolean | |
expose_identity_source |
boolean | |
expose_active_isds |
boolean |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
created |
string (date-time) | |
modified |
string (date-time) | |
offering_uuid |
string (uuid) | |
offering_name |
string | |
expose_username |
boolean | |
expose_full_name |
boolean | |
expose_email |
boolean | |
expose_phone_number |
boolean | |
expose_organization |
boolean | |
expose_job_title |
boolean | |
expose_affiliations |
boolean | |
expose_gender |
boolean | |
expose_personal_title |
boolean | |
expose_place_of_birth |
boolean | |
expose_country_of_residence |
boolean | |
expose_nationality |
boolean | |
expose_nationalities |
boolean | |
expose_organization_country |
boolean | |
expose_organization_type |
boolean | |
expose_organization_registry_code |
boolean | |
expose_eduperson_assurance |
boolean | |
expose_civil_number |
boolean | |
expose_birth_date |
boolean | |
expose_identity_source |
boolean | |
expose_active_isds |
boolean | |
exposed_fields |
array of strings | Return list of field names currently configured for exposure. |
is_default |
boolean | Return True if this is a default (unsaved) config. |
Update user attribute config
Creates or updates the user attribute configuration for this offering. This determines which user attributes are shared with the service provider.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
OfferingUserAttributeConfigRequest - API Source:
marketplace_provider_offerings_update_user_attribute_config_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
offering |
string (uuid) | |
expose_username |
boolean | |
expose_full_name |
boolean | |
expose_email |
boolean | |
expose_phone_number |
boolean | |
expose_organization |
boolean | |
expose_job_title |
boolean | |
expose_affiliations |
boolean | |
expose_gender |
boolean | |
expose_personal_title |
boolean | |
expose_place_of_birth |
boolean | |
expose_country_of_residence |
boolean | |
expose_nationality |
boolean | |
expose_nationalities |
boolean | |
expose_organization_country |
boolean | |
expose_organization_type |
boolean | |
expose_organization_registry_code |
boolean | |
expose_eduperson_assurance |
boolean | |
expose_civil_number |
boolean | |
expose_birth_date |
boolean | |
expose_identity_source |
boolean | |
expose_active_isds |
boolean |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
created |
string (date-time) | |
modified |
string (date-time) | |
offering_uuid |
string (uuid) | |
offering_name |
string | |
expose_username |
boolean | |
expose_full_name |
boolean | |
expose_email |
boolean | |
expose_phone_number |
boolean | |
expose_organization |
boolean | |
expose_job_title |
boolean | |
expose_affiliations |
boolean | |
expose_gender |
boolean | |
expose_personal_title |
boolean | |
expose_place_of_birth |
boolean | |
expose_country_of_residence |
boolean | |
expose_nationality |
boolean | |
expose_nationalities |
boolean | |
expose_organization_country |
boolean | |
expose_organization_type |
boolean | |
expose_organization_registry_code |
boolean | |
expose_eduperson_assurance |
boolean | |
expose_civil_number |
boolean | |
expose_birth_date |
boolean | |
expose_identity_source |
boolean | |
expose_active_isds |
boolean | |
exposed_fields |
array of strings | Return list of field names currently configured for exposure. |
is_default |
boolean | Return True if this is a default (unsaved) config. |
Update user attribute config
Creates or updates the user attribute configuration for this offering. This determines which user attributes are shared with the service provider.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
offering |
string (uuid) | |
expose_username |
boolean | |
expose_full_name |
boolean | |
expose_email |
boolean | |
expose_phone_number |
boolean | |
expose_organization |
boolean | |
expose_job_title |
boolean | |
expose_affiliations |
boolean | |
expose_gender |
boolean | |
expose_personal_title |
boolean | |
expose_place_of_birth |
boolean | |
expose_country_of_residence |
boolean | |
expose_nationality |
boolean | |
expose_nationalities |
boolean | |
expose_organization_country |
boolean | |
expose_organization_type |
boolean | |
expose_organization_registry_code |
boolean | |
expose_eduperson_assurance |
boolean | |
expose_civil_number |
boolean | |
expose_birth_date |
boolean | |
expose_identity_source |
boolean | |
expose_active_isds |
boolean |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
created |
string (date-time) | |
modified |
string (date-time) | |
offering_uuid |
string (uuid) | |
offering_name |
string | |
expose_username |
boolean | |
expose_full_name |
boolean | |
expose_email |
boolean | |
expose_phone_number |
boolean | |
expose_organization |
boolean | |
expose_job_title |
boolean | |
expose_affiliations |
boolean | |
expose_gender |
boolean | |
expose_personal_title |
boolean | |
expose_place_of_birth |
boolean | |
expose_country_of_residence |
boolean | |
expose_nationality |
boolean | |
expose_nationalities |
boolean | |
expose_organization_country |
boolean | |
expose_organization_type |
boolean | |
expose_organization_registry_code |
boolean | |
expose_eduperson_assurance |
boolean | |
expose_civil_number |
boolean | |
expose_birth_date |
boolean | |
expose_identity_source |
boolean | |
expose_active_isds |
boolean | |
exposed_fields |
array of strings | Return list of field names currently configured for exposure. |
is_default |
boolean | Return True if this is a default (unsaved) config. |
Delete user attribute config
Deletes the user attribute configuration for this offering. The offering will fall back to system defaults.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Offering Components
Create an offering component
Adds a new custom component to an offering.
1 2 3 4 5 6 7 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | |
- Model Source:
OfferingComponentRequest - API Source:
marketplace_provider_offerings_create_offering_component
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
billing_type |
string | ✓ | Enum: fixed, usage, limit, one, few |
type |
string | ✓ | Unique internal name of the measured unit, for example floating_ip. |
name |
string | ✓ | Display name for the measured unit, for example, Floating IP. |
description |
string | ||
measured_unit |
string | Unit of measurement, for example, GB. | |
unit_factor |
integer | The conversion factor from backend units to measured_unit | |
limit_period |
any | ||
limit_amount |
integer | ||
article_code |
string | ||
max_value |
integer | ||
min_value |
integer | ||
max_available_limit |
integer | ||
is_boolean |
boolean | ||
default_limit |
integer | ||
is_prepaid |
boolean | ||
overage_component |
string (uuid) | ||
min_prepaid_duration |
integer | ||
max_prepaid_duration |
integer |
201 - No response body
Remove an offering component
Removes a custom component from an offering. Built-in components cannot be removed.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
RemoveOfferingComponentRequest - API Source:
marketplace_provider_offerings_remove_offering_component
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
uuid |
string (uuid) | ✓ | UUID of the component to remove |
200 - No response body
Update an offering component
Updates the properties of a specific component within an offering.
1 2 3 4 5 6 7 8 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 | |
- Model Source:
UpdateOfferingComponentRequest - API Source:
marketplace_provider_offerings_update_offering_component
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
uuid |
string (uuid) | ✓ | |
billing_type |
string | ✓ | Enum: fixed, usage, limit, one, few |
type |
string | ✓ | Unique internal name of the measured unit, for example floating_ip. |
name |
string | ✓ | Display name for the measured unit, for example, Floating IP. |
description |
string | ||
measured_unit |
string | Unit of measurement, for example, GB. | |
unit_factor |
integer | The conversion factor from backend units to measured_unit | |
limit_period |
any | ||
limit_amount |
integer | ||
article_code |
string | ||
max_value |
integer | ||
min_value |
integer | ||
max_available_limit |
integer | ||
is_boolean |
boolean | ||
default_limit |
integer | ||
is_prepaid |
boolean | ||
overage_component |
string (uuid) | ||
min_prepaid_duration |
integer | ||
max_prepaid_duration |
integer |
200 - No response body
Software Catalogs and Partitions
Add a partition to an offering
Adds a new partition configuration to an offering.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
OfferingPartitionRequest - API Source:
marketplace_provider_offerings_add_partition
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
offering |
string (uuid) | ✓ | |
partition_name |
string | ✓ | Name of the SLURM partition |
cpu_bind |
integer | Default task binding policy (SLURM cpu_bind) | |
def_cpu_per_gpu |
integer | Default CPUs allocated per GPU | |
max_cpus_per_node |
integer | Maximum allocated CPUs per node | |
max_cpus_per_socket |
integer | Maximum allocated CPUs per socket | |
def_mem_per_cpu |
integer (int64) | Default memory per CPU in MB | |
def_mem_per_gpu |
integer (int64) | Default memory per GPU in MB | |
def_mem_per_node |
integer (int64) | Default memory per node in MB | |
max_mem_per_cpu |
integer (int64) | Maximum memory per CPU in MB | |
max_mem_per_node |
integer (int64) | Maximum memory per node in MB | |
default_time |
integer | Default time limit in minutes | |
max_time |
integer | Maximum time limit in minutes | |
grace_time |
integer | Preemption grace time in seconds | |
max_nodes |
integer | Maximum nodes per job | |
min_nodes |
integer | Minimum nodes per job | |
exclusive_topo |
boolean | Exclusive topology access required | |
exclusive_user |
boolean | Exclusive user access required | |
priority_tier |
integer | Priority tier for scheduling and preemption | |
qos |
string | Quality of Service (QOS) name | |
req_resv |
boolean | Require reservation for job allocation |
201 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
created |
string (date-time) | |
modified |
string (date-time) | |
offering |
string (uuid) | |
offering_name |
string | |
partition_name |
string | Name of the SLURM partition |
cpu_bind |
integer | Default task binding policy (SLURM cpu_bind) |
def_cpu_per_gpu |
integer | Default CPUs allocated per GPU |
max_cpus_per_node |
integer | Maximum allocated CPUs per node |
max_cpus_per_socket |
integer | Maximum allocated CPUs per socket |
def_mem_per_cpu |
integer (int64) | Default memory per CPU in MB |
def_mem_per_gpu |
integer (int64) | Default memory per GPU in MB |
def_mem_per_node |
integer (int64) | Default memory per node in MB |
max_mem_per_cpu |
integer (int64) | Maximum memory per CPU in MB |
max_mem_per_node |
integer (int64) | Maximum memory per node in MB |
default_time |
integer | Default time limit in minutes |
max_time |
integer | Maximum time limit in minutes |
grace_time |
integer | Preemption grace time in seconds |
max_nodes |
integer | Maximum nodes per job |
min_nodes |
integer | Minimum nodes per job |
exclusive_topo |
boolean | Exclusive topology access required |
exclusive_user |
boolean | Exclusive user access required |
priority_tier |
integer | Priority tier for scheduling and preemption |
qos |
string | Quality of Service (QOS) name |
req_resv |
boolean | Require reservation for job allocation |
Add a software catalog to an offering
Associates a software catalog with an offering and configures enabled CPU architectures.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
OfferingSoftwareCatalogRequest - API Source:
marketplace_provider_offerings_add_software_catalog
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
offering |
string (uuid) | ✓ | |
catalog |
string (uuid) | ✓ | |
enabled_cpu_family |
any | List of enabled CPU families: ['x86_64', 'aarch64'] | |
enabled_cpu_microarchitectures |
any | List of enabled CPU microarchitectures: ['generic', 'zen3'] | |
partition |
string (uuid) |
201 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | UUID of the software catalog |
Remove a partition from an offering
Removes a partition configuration from an offering.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
RemovePartitionRequest - API Source:
marketplace_provider_offerings_remove_partition
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
partition_uuid |
string (uuid) | ✓ |
204 - No response body
Remove a software catalog from an offering
Disassociates a software catalog from an offering.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
RemoveSoftwareCatalogRequest - API Source:
marketplace_provider_offerings_remove_software_catalog
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
offering_catalog_uuid |
string (uuid) | ✓ | UUID of the offering catalog to remove |
204 - No response body
Update a partition of an offering
Updates the configuration of an existing partition associated with an offering.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedOfferingPartitionUpdateRequest - API Source:
marketplace_provider_offerings_update_partition_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
partition_uuid |
string (uuid) | Constraints: write-only |
|
partition_name |
string | Name of the SLURM partition | |
cpu_bind |
integer | Default task binding policy (SLURM cpu_bind) | |
def_cpu_per_gpu |
integer | Default CPUs allocated per GPU | |
max_cpus_per_node |
integer | Maximum allocated CPUs per node | |
max_cpus_per_socket |
integer | Maximum allocated CPUs per socket | |
def_mem_per_cpu |
integer (int64) | Default memory per CPU in MB | |
def_mem_per_gpu |
integer (int64) | Default memory per GPU in MB | |
def_mem_per_node |
integer (int64) | Default memory per node in MB | |
max_mem_per_cpu |
integer (int64) | Maximum memory per CPU in MB | |
max_mem_per_node |
integer (int64) | Maximum memory per node in MB | |
default_time |
integer | Default time limit in minutes | |
max_time |
integer | Maximum time limit in minutes | |
grace_time |
integer | Preemption grace time in seconds | |
max_nodes |
integer | Maximum nodes per job | |
min_nodes |
integer | Minimum nodes per job | |
exclusive_topo |
boolean | Exclusive topology access required | |
exclusive_user |
boolean | Exclusive user access required | |
priority_tier |
integer | Priority tier for scheduling and preemption | |
qos |
string | Quality of Service (QOS) name | |
req_resv |
boolean | Require reservation for job allocation |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
created |
string (date-time) | |
modified |
string (date-time) | |
offering |
string (uuid) | |
offering_name |
string | |
partition_name |
string | Name of the SLURM partition |
cpu_bind |
integer | Default task binding policy (SLURM cpu_bind) |
def_cpu_per_gpu |
integer | Default CPUs allocated per GPU |
max_cpus_per_node |
integer | Maximum allocated CPUs per node |
max_cpus_per_socket |
integer | Maximum allocated CPUs per socket |
def_mem_per_cpu |
integer (int64) | Default memory per CPU in MB |
def_mem_per_gpu |
integer (int64) | Default memory per GPU in MB |
def_mem_per_node |
integer (int64) | Default memory per node in MB |
max_mem_per_cpu |
integer (int64) | Maximum memory per CPU in MB |
max_mem_per_node |
integer (int64) | Maximum memory per node in MB |
default_time |
integer | Default time limit in minutes |
max_time |
integer | Maximum time limit in minutes |
grace_time |
integer | Preemption grace time in seconds |
max_nodes |
integer | Maximum nodes per job |
min_nodes |
integer | Minimum nodes per job |
exclusive_topo |
boolean | Exclusive topology access required |
exclusive_user |
boolean | Exclusive user access required |
priority_tier |
integer | Priority tier for scheduling and preemption |
qos |
string | Quality of Service (QOS) name |
req_resv |
boolean | Require reservation for job allocation |
Update software catalog configuration
Updates the configuration of a software catalog associated with an offering, such as enabled architectures or partition.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
offering_catalog_uuid |
string (uuid) | Constraints: write-only |
|
catalog |
string (uuid) | ||
enabled_cpu_family |
any | List of enabled CPU families: ['x86_64', 'aarch64'] | |
enabled_cpu_microarchitectures |
any | List of enabled CPU microarchitectures: ['generic', 'zen3'] | |
partition |
string (uuid) |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
created |
string (date-time) | |
modified |
string (date-time) | |
offering |
string (uuid) | |
catalog |
string (uuid) | |
offering_name |
string | |
catalog_name |
string | |
catalog_version |
string | |
enabled_cpu_family |
any | List of enabled CPU families: ['x86_64', 'aarch64'] |
enabled_cpu_microarchitectures |
any | List of enabled CPU microarchitectures: ['generic', 'zen3'] |
partition |
string (uuid) | |
partition_name |
string |
Endpoints
Add an access endpoint to an offering
Adds a new access endpoint (URL) to an offering.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
NestedEndpointRequest - API Source:
marketplace_provider_offerings_add_endpoint
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ✓ | |
url |
string | ✓ | URL of the access endpoint |
201 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | UUID of the access endpoint |
Delete an access endpoint from an offering
Deletes an existing access endpoint from an offering by its UUID.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
EndpointUUIDRequest - API Source:
marketplace_provider_offerings_delete_endpoint
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
uuid |
string (uuid) | ✓ | UUID of the access endpoint |
204 - No response body
Attachments and Images
Delete offering image
Deletes the main image of an offering.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_provider_offerings_delete_image
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Delete offering thumbnail
Deletes the thumbnail image of an offering.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_provider_offerings_delete_thumbnail
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Update offering image
Uploads or replaces the main image for an offering.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
OfferingImageRequest - API Source:
marketplace_provider_offerings_update_image
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
image |
string (binary) | ✓ |
200 - No response body
Update offering thumbnail
Uploads or replaces the thumbnail image for an offering.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
OfferingThumbnailRequest - API Source:
marketplace_provider_offerings_update_thumbnail
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
thumbnail |
string (binary) | ✓ |
200 - No response body
Configuration & Updates
Delete organization groups for offering
Removes all organization group associations from this offering, making it accessible to all.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Move an offering
Moves an offering to a different service provider. Requires staff permissions.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
MoveOfferingRequest - API Source:
marketplace_provider_offerings_move_offering
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
customer |
string (uri) | ✓ | Target customer URL with service provider profile where the offering should be moved |
preserve_permissions |
boolean | ✓ | Whether to preserve existing permissions when moving the offering |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
name |
string | |
slug |
string | URL-friendly identifier. Only editable by staff users. |
description |
string | |
full_description |
string | |
privacy_policy_link |
string (uri) | |
access_url |
string (uri) | Publicly accessible offering access URL |
endpoints |
array of objects | |
endpoints.uuid |
string (uuid) | |
endpoints.name |
string | |
endpoints.url |
string | URL of the access endpoint |
software_catalogs |
array of objects | |
software_catalogs.uuid |
string (uuid) | |
software_catalogs.catalog |
any | |
software_catalogs.enabled_cpu_family |
any | List of enabled CPU families: ['x86_64', 'aarch64'] |
software_catalogs.enabled_cpu_microarchitectures |
any | List of enabled CPU microarchitectures: ['generic', 'zen3'] |
software_catalogs.package_count |
integer | |
software_catalogs.partition |
any | |
partitions |
array of objects | |
partitions.uuid |
string (uuid) | |
partitions.partition_name |
string | Name of the SLURM partition |
partitions.cpu_bind |
integer | Default task binding policy (SLURM cpu_bind) |
partitions.def_cpu_per_gpu |
integer | Default CPUs allocated per GPU |
partitions.max_cpus_per_node |
integer | Maximum allocated CPUs per node |
partitions.max_cpus_per_socket |
integer | Maximum allocated CPUs per socket |
partitions.def_mem_per_cpu |
integer (int64) | Default memory per CPU in MB |
partitions.def_mem_per_gpu |
integer (int64) | Default memory per GPU in MB |
partitions.def_mem_per_node |
integer (int64) | Default memory per node in MB |
partitions.max_mem_per_cpu |
integer (int64) | Maximum memory per CPU in MB |
partitions.max_mem_per_node |
integer (int64) | Maximum memory per node in MB |
partitions.default_time |
integer | Default time limit in minutes |
partitions.max_time |
integer | Maximum time limit in minutes |
partitions.grace_time |
integer | Preemption grace time in seconds |
partitions.max_nodes |
integer | Maximum nodes per job |
partitions.min_nodes |
integer | Minimum nodes per job |
partitions.exclusive_topo |
boolean | Exclusive topology access required |
partitions.exclusive_user |
boolean | Exclusive user access required |
partitions.priority_tier |
integer | Priority tier for scheduling and preemption |
partitions.qos |
string | Quality of Service (QOS) name |
partitions.req_resv |
boolean | Require reservation for job allocation |
roles |
array of objects | |
roles.uuid |
string (uuid) | |
roles.name |
string | |
roles.url |
string (uri) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
project |
string (uri) | |
project_uuid |
string (uuid) | |
project_name |
string | |
category |
string (uri) | |
category_uuid |
string (uuid) | |
category_title |
string | |
attributes |
object (free-form) | |
options |
any | |
resource_options |
any | |
components |
array of objects | |
components.uuid |
string (uuid) | |
components.billing_type |
string | Enum: fixed, usage, limit, one, few |
components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
components.name |
string | Display name for the measured unit, for example, Floating IP. |
components.description |
string | |
components.measured_unit |
string | Unit of measurement, for example, GB. |
components.unit_factor |
integer | The conversion factor from backend units to measured_unit |
components.limit_period |
any | |
components.limit_amount |
integer | |
components.article_code |
string | |
components.max_value |
integer | |
components.min_value |
integer | |
components.max_available_limit |
integer | |
components.is_boolean |
boolean | |
components.default_limit |
integer | |
components.factor |
integer | |
components.is_builtin |
boolean | |
components.is_prepaid |
boolean | |
components.overage_component |
string (uuid) | |
components.min_prepaid_duration |
integer | |
components.max_prepaid_duration |
integer | |
plugin_options |
any | |
state |
any | |
vendor_details |
string | |
getting_started |
string | |
integration_guide |
string | |
thumbnail |
string (uri) | |
order_count |
integer | |
plans |
array of objects | |
plans.url |
string (uri) | |
plans.uuid |
string (uuid) | |
plans.name |
string | |
plans.description |
string | |
plans.article_code |
string | |
plans.max_amount |
integer | Maximum number of plans that could be active. Plan is disabled when maximum amount is reached. |
plans.archived |
boolean | Forbids creation of new resources. |
plans.is_active |
boolean | |
plans.unit_price |
string (decimal) | |
plans.unit |
string | Enum: month, quarter, half_month, day, hour, quantity |
plans.init_price |
number (double) | |
plans.switch_price |
number (double) | |
plans.backend_id |
string | |
plans.organization_groups |
array of objects | |
plans.organization_groups.uuid |
string (uuid) | |
plans.organization_groups.url |
string (uri) | |
plans.organization_groups.name |
string | |
plans.organization_groups.parent_uuid |
string (uuid) | UUID of the parent organization group |
plans.organization_groups.parent_name |
string | Name of the parent organization group |
plans.organization_groups.parent |
string (uri) | |
plans.organization_groups.customers_count |
integer | Number of customers in this organization group |
plans.components |
array of objects | |
plans.components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
plans.components.name |
string | Display name for the measured unit, for example, Floating IP. |
plans.components.measured_unit |
string | Unit of measurement, for example, GB. |
plans.components.amount |
integer | |
plans.components.price |
string (decimal) | |
plans.components.future_price |
string (decimal) | |
plans.components.discount_threshold |
integer | Minimum amount to be eligible for discount. |
plans.components.discount_rate |
integer | Discount rate in percentage. |
plans.prices |
object (free-form) | |
plans.future_prices |
object (free-form) | |
plans.quotas |
object (free-form) | |
plans.resources_count |
integer | |
plans.plan_type |
string | |
plans.minimal_price |
number (double) | |
screenshots |
array of objects | |
screenshots.name |
string | |
screenshots.uuid |
string (uuid) | |
screenshots.description |
string | |
screenshots.image |
string (uri) | |
screenshots.thumbnail |
string (uri) | |
screenshots.created |
string (date-time) | |
type |
string | |
shared |
boolean | Accessible to all customers. |
billable |
boolean | Purchase and usage is invoiced. |
scope |
string | |
scope_uuid |
string (uuid) | |
scope_name |
string (uuid) | |
scope_state |
any | |
scope_error_message |
string | |
files |
array of objects | |
files.name |
string | |
files.created |
string (date-time) | |
files.file |
string (uri) | |
quotas |
array of objects | |
quotas.name |
string | |
quotas.usage |
integer | |
quotas.limit |
integer | |
paused_reason |
string | |
datacite_doi |
string | |
citation_count |
integer | Number of citations of a DOI |
latitude |
number (double) | |
longitude |
number (double) | |
country |
any | Country code (ISO 3166-1 alpha-2) |
backend_id |
string | |
organization_groups |
array of objects | |
organization_groups.uuid |
string (uuid) | |
organization_groups.url |
string (uri) | |
organization_groups.name |
string | |
organization_groups.parent_uuid |
string (uuid) | UUID of the parent organization group |
organization_groups.parent_name |
string | Name of the parent organization group |
organization_groups.parent |
string (uri) | |
organization_groups.customers_count |
integer | Number of customers in this organization group |
tags |
array of objects | |
tags.uuid |
string (uuid) | |
tags.name |
string | |
image |
string (uri) | |
total_customers |
integer | |
total_cost |
integer | |
total_cost_estimated |
integer | |
parent_description |
string | |
parent_uuid |
string (uuid) | |
parent_name |
string | |
backend_metadata |
any | |
has_compliance_requirements |
boolean | |
billing_type_classification |
string | Classify offering components by billing type. Returns 'limit_only', 'usage_only', or 'mixed'. |
compliance_checklist |
string (uri) | |
user_has_consent |
boolean | |
is_accessible |
boolean | |
google_calendar_is_public |
boolean | |
google_calendar_link |
string | Get the Google Calendar link for an offering. |
promotion_campaigns |
array of objects | |
promotion_campaigns.uuid |
string (uuid) | |
promotion_campaigns.name |
string | |
promotion_campaigns.start_date |
string (date) | Starting from this date, the campaign is active. |
promotion_campaigns.end_date |
string (date) | The last day the campaign is active. |
promotion_campaigns.discount_type |
string | Enum: discount, special_price |
promotion_campaigns.discount |
integer | |
promotion_campaigns.stock |
integer | |
promotion_campaigns.description |
string | |
promotion_campaigns.months |
integer | How many months in a row should the related service (when activated) get special deal (0 for indefinitely until active) |
promotion_campaigns.service_provider |
string (uri) |
Set offering backend metadata
Updates the backend-specific metadata for an offering.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
OfferingBackendMetadataRequest - API Source:
marketplace_provider_offerings_set_backend_metadata
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
backend_metadata |
any |
200 - No response body
Update offering attributes
Updates the attributes of an offering.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_provider_offerings_update_attributes
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - No response body
Update offering compliance checklist
Associates a compliance checklist with an offering.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
OfferingComplianceChecklistUpdateRequest - API Source:
marketplace_provider_offerings_update_compliance_checklist
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
compliance_checklist |
string (uuid) |
200 - No response body
Update offering category
Updates the category of an offering.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
OfferingDescriptionUpdateRequest - API Source:
marketplace_provider_offerings_update_description
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
category |
string (uri) | ✓ |
200 - No response body
Update offering integration settings
Updates the backend integration settings for an offering, including plugin options, secret options, and service attributes.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
OfferingIntegrationUpdateRequest - API Source:
marketplace_provider_offerings_update_integration
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
secret_options |
object | ||
secret_options.heappe_cluster_password |
string | HEAppE cluster password | |
secret_options.heappe_password |
string | HEAppE password | |
secret_options.ipv4_external_ip_mapping |
array of objects | OpenStack IPv4 external IP mapping | |
secret_options.ipv4_external_ip_mapping.floating_ip |
string | ✓ | Floating IP |
secret_options.ipv4_external_ip_mapping.external_ip |
string | ✓ | External IP |
secret_options.openstack_api_tls_certificate |
string | TLS certificate for OpenStack API connection verification | |
secret_options.dns_nameservers |
array of strings | Default value for new subnets DNS name servers. Should be defined as list. | |
secret_options.shared_user_password |
string | GLAuth shared user password | |
secret_options.template_confirmation_comment |
string | Template confirmation comment | |
secret_options.language |
string | Script language: Python or Bash | |
secret_options.environ |
any | Script environment variables | |
secret_options.create |
string | Script for resource creation | |
secret_options.terminate |
string | Script for resource termination | |
secret_options.update |
string | Script for resource update | |
secret_options.pull |
string | Script for regular resource pull | |
secret_options.api_url |
string | API URL | |
secret_options.token |
string | Waldur access token | |
secret_options.customer_uuid |
string | Organization UUID | |
secret_options.backend_url |
string | ||
secret_options.username |
string | ||
secret_options.password |
string | ||
secret_options.cloud_init_template |
string | Cloud-init template for Rancher cluster node initialization | |
secret_options.managed_rancher_load_balancer_cloud_init_template |
string | Cloud-init template for managed Rancher load balancer initialization | |
secret_options.vault_host |
string | Host of the Vault server | |
secret_options.vault_port |
integer | Port of the Vault server | |
secret_options.vault_token |
string | Token for the Vault server | |
secret_options.vault_tls_verify |
boolean | Whether to verify the Vault server certificate | |
secret_options.keycloak_url |
string | URL of the Keycloak server | |
secret_options.keycloak_realm |
string | Keycloak realm for Rancher | |
secret_options.keycloak_user_realm |
string | Keycloak user realm for auth | |
secret_options.keycloak_username |
string | Username of the Keycloak integration user | |
secret_options.keycloak_password |
string | Password of the Keycloak integration user | |
secret_options.keycloak_sync_frequency |
integer | Frequency in minutes for syncing Keycloak users | |
secret_options.keycloak_ssl_verify |
boolean | Indicates whether verify SSL certificates | |
secret_options.argocd_k8s_namespace |
string | Namespace where ArgoCD is deployed | |
secret_options.argocd_k8s_kubeconfig |
string | Kubeconfig with access to namespace where ArgoCD is deployed | |
secret_options.base_image_name |
string | Base image name | |
secret_options.private_registry_url |
string | URL of a private registry for a cluster | |
secret_options.private_registry_user |
string | Username for accessing a private registry | |
secret_options.private_registry_password |
string | Password for accessing a private registry | |
secret_options.k8s_version |
string | Kubernetes version | |
secret_options.node_disk_driver |
any | OpenStack disk driver for Rancher nodes | |
plugin_options |
object | ||
plugin_options.auto_approve_remote_orders |
boolean | If set to True, an order can be processed without approval | |
plugin_options.resource_expiration_threshold |
integer | Resource expiration threshold in days. Constraints: default: 30 |
|
plugin_options.service_provider_can_create_offering_user |
boolean | Service provider can create offering user | |
plugin_options.max_resource_termination_offset_in_days |
integer | Maximum resource termination offset in days | |
plugin_options.default_resource_termination_offset_in_days |
integer | If set, it will be used as a default resource termination offset in days | |
plugin_options.is_resource_termination_date_required |
boolean | If set to True, resource termination date is required | |
plugin_options.latest_date_for_resource_termination |
string | If set, it will be used as a latest date for resource termination. Format: YYYY-MM-DD | |
plugin_options.auto_approve_in_service_provider_projects |
boolean | Skip approval of public offering belonging to the same organization under which the request is done | |
plugin_options.disable_autoapprove |
boolean | If set to True, orders for this offering will always require manual approval, overriding auto_approve_in_service_provider_projects | |
plugin_options.supports_downscaling |
boolean | If set to True, it will be possible to downscale resources | |
plugin_options.supports_pausing |
boolean | If set to True, it will be possible to pause resources | |
plugin_options.minimal_team_count_for_provisioning |
integer | Minimal team count required for provisioning of resources | |
plugin_options.maximal_resource_count_per_project |
integer | Maximal number of offering resources allowed per project | |
plugin_options.unique_resource_per_attribute |
string | Attribute name to enforce uniqueness per value. E.g., 'storage_data_type' ensures only one resource per storage type per project. | |
plugin_options.required_team_role_for_provisioning |
string | Required user role in a project for provisioning of resources | |
plugin_options.enable_purchase_order_upload |
boolean | If set to True, users will be able to upload purchase orders. | |
plugin_options.require_purchase_order_upload |
boolean | If set to True, users will be required to upload purchase orders. | |
plugin_options.conceal_billing_data |
boolean | If set to True, pricing and components tab would be concealed. | |
plugin_options.create_orders_on_resource_option_change |
boolean | If set to True, create orders when options of related resources are changed. | |
plugin_options.can_restore_resource |
boolean | If set to True, resource can be restored. | |
plugin_options.enable_provider_consumer_messaging |
boolean | If set to True, service providers can send messages with attachments to consumers on pending orders, and consumers can respond. | |
plugin_options.notify_about_provider_consumer_messages |
boolean | If set to True, send email notifications when providers or consumers exchange messages on pending orders. | |
plugin_options.restrict_deletion_with_active_resources |
boolean | If set to True, offering cannot be deleted while it has non-terminated resources. | |
plugin_options.resource_name_pattern |
string | Python format string for generating resource names. Available variables: {customer_name}, {customer_slug}, {project_name}, {project_slug}, {offering_name}, {offering_slug}, {plan_name}, {counter}, {attributes[KEY]}. | |
plugin_options.default_internal_network_mtu |
integer | If set, it will be used as a default MTU for the first network in a tenant | |
plugin_options.max_instances |
integer | Default limit for number of instances in OpenStack tenant | |
plugin_options.max_volumes |
integer | Default limit for number of volumes in OpenStack tenant | |
plugin_options.max_security_groups |
integer | Default limit for number of security groups in OpenStack tenant | |
plugin_options.storage_mode |
any | Storage mode for OpenStack offering | |
plugin_options.snapshot_size_limit_gb |
integer | Default limit for snapshot size in GB | |
plugin_options.heappe_cluster_id |
string | HEAppE cluster id | |
plugin_options.heappe_local_base_path |
string | HEAppE local base path | |
plugin_options.heappe_url |
string | HEAppE url | |
plugin_options.heappe_username |
string | HEAppE username | |
plugin_options.homedir_prefix |
string | GLAuth homedir prefix Constraints: default: /home/ |
|
plugin_options.scratch_project_directory |
string | HEAppE scratch project directory | |
plugin_options.project_permanent_directory |
string | HEAppE project permanent directory | |
plugin_options.initial_primarygroup_number |
integer | GLAuth initial primary group number Constraints: default: 5000 |
|
plugin_options.initial_uidnumber |
integer | GLAuth initial uidnumber Constraints: default: 5000 |
|
plugin_options.initial_usergroup_number |
integer | GLAuth initial usergroup number Constraints: default: 6000 |
|
plugin_options.username_anonymized_prefix |
string | GLAuth prefix for anonymized usernames Constraints: default: waldur_ |
|
plugin_options.username_generation_policy |
any | GLAuth username generation policy Constraints: default: service_provider |
|
plugin_options.enable_issues_for_membership_changes |
boolean | Enable issues for membership changes | |
plugin_options.deployment_mode |
any | Rancher deployment mode | |
plugin_options.flavors_regex |
string | Regular expression to limit flavors list | |
plugin_options.openstack_offering_uuid_list |
array of strings | List of UUID of OpenStack offerings where tenant can be created | |
plugin_options.managed_rancher_server_flavor_name |
string | Flavor name for managed Rancher server instances | |
plugin_options.managed_rancher_server_system_volume_size_gb |
integer | System volume size in GB for managed Rancher server | |
plugin_options.managed_rancher_server_system_volume_type_name |
string | System volume type name for managed Rancher server | |
plugin_options.managed_rancher_server_data_volume_size_gb |
integer | Data volume size in GB for managed Rancher server | |
plugin_options.managed_rancher_server_data_volume_type_name |
string | Data volume type name for managed Rancher server | |
plugin_options.managed_rancher_worker_system_volume_size_gb |
integer | System volume size in GB for managed Rancher worker nodes | |
plugin_options.managed_rancher_worker_system_volume_type_name |
string | System volume type name for managed Rancher worker nodes | |
plugin_options.managed_rancher_load_balancer_flavor_name |
string | Flavor name for managed Rancher load balancer | |
plugin_options.managed_rancher_load_balancer_system_volume_size_gb |
integer | System volume size in GB for managed Rancher load balancer | |
plugin_options.managed_rancher_load_balancer_system_volume_type_name |
string | System volume type name for managed Rancher load balancer | |
plugin_options.managed_rancher_load_balancer_data_volume_size_gb |
integer | Data volume size in GB for managed Rancher load balancer | |
plugin_options.managed_rancher_load_balancer_data_volume_type_name |
string | Data volume type name for managed Rancher load balancer | |
plugin_options.managed_rancher_tenant_max_cpu |
integer | Max number of vCPUs for tenants | |
plugin_options.managed_rancher_tenant_max_ram |
integer | Max number of RAM for tenants (GB) | |
plugin_options.managed_rancher_tenant_max_disk |
integer | Max size of disk space for tenants (GB) | |
plugin_options.account_name_generation_policy |
any | Slurm account name generation policy | |
plugin_options.enable_display_of_order_actions_for_service_provider |
boolean | Enable display of order actions for service provider Constraints: default: True |
|
plugin_options.slurm_periodic_policy_enabled |
boolean | Enable SLURM periodic usage policy configuration. When enabled, allows configuring QoS-based threshold enforcement, carryover logic, and fairshare decay for site-agent managed SLURM offerings. Constraints: default: False |
|
plugin_options.auto_approve_marketplace_script |
boolean | If set to False, all orders require manual provider approval, including for service provider owners and staff Constraints: default: True |
|
plugin_options.keycloak_enabled |
boolean | If set to True, Keycloak group management is enabled for this offering. | |
plugin_options.keycloak_base_group |
string | Root parent group in Keycloak under which offering groups are created. Groups are organized as: {base_group}/{offering_slug}/{role_group}. If empty, offering groups are created at the realm root. | |
plugin_options.keycloak_sync_frequency |
integer | Frequency in minutes for syncing Keycloak group memberships. | |
plugin_options.keycloak_group_name_template |
string | Template for generating Keycloak group names. Uses $variable syntax (e.g. $offering_uuid_$role_name). Allowed variables: offering_uuid, offering_name, offering_slug, resource_uuid, resource_name, resource_slug, project_uuid, project_name, project_slug, organization_uuid, organization_name, organization_slug, role_name, scope_id. | |
plugin_options.keycloak_username_label |
string | Custom label for the username field when inviting external users (e.g. 'Civil code', 'CUID'). If empty, defaults to 'Username'. Constraints: default: `` |
|
plugin_options.highlight_backend_id_display |
boolean | Defines if backend_id should be shown more prominently by the UI Constraints: default: False |
|
plugin_options.backend_id_display_label |
string | Label used by UI for showing value of the backend_id Constraints: default: Backend ID |
|
plugin_options.disabled_resource_actions |
array of strings | List of disabled marketplace resource actions for this offering. | |
service_attributes |
any | ||
backend_id |
string |
200 - No response body
Update offering location
Updates the geographical location (latitude and longitude) of an offering.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
OfferingLocationUpdateRequest - API Source:
marketplace_provider_offerings_update_location
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
latitude |
number (double) | ✓ |
longitude |
number (double) | ✓ |
200 - No response body
Update offering options
Updates the order form options for an offering.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
OfferingOptionsUpdateRequest - API Source:
marketplace_provider_offerings_update_options
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
options |
object | ✓ |
options.order |
array of strings | ✓ |
options.options |
object (free-form) | ✓ |
200 - No response body
Update organization groups for offering
Sets the list of organization groups that can access this offering.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
OrganizationGroupsRequest - API Source:
marketplace_provider_offerings_update_organization_groups
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
organization_groups |
array of string (uri)s |
200 - No response body
Update offering overview
Updates the overview fields of an offering, such as name, description, and getting started guide.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
OfferingOverviewUpdateRequest - API Source:
marketplace_provider_offerings_update_overview
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ✓ | |
description |
string | ||
full_description |
string | ||
privacy_policy_link |
string (uri) | ||
access_url |
string (uri) | Publicly accessible offering access URL | |
getting_started |
string | ||
integration_guide |
string | ||
slug |
string | URL-friendly identifier. Only editable by staff users. |
200 - No response body
Update offering resource options
Updates the resource report form options for an offering.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
OfferingResourceOptionsUpdateRequest - API Source:
marketplace_provider_offerings_update_resource_options
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
resource_options |
object | ✓ |
resource_options.order |
array of strings | ✓ |
resource_options.options |
object (free-form) | ✓ |
200 - No response body
Data & Reporting
Get statistics for offering components
Returns monthly usage statistics for the components of an offering within a specified date range.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
- Model Source:
OfferingState - Model Source:
ProviderOfferingDetailsOEnum - API Source:
marketplace_provider_offerings_component_stats_list
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
accessible_via_calls |
boolean | Accessible via calls |
allowed_customer_uuid |
string (uuid) | Allowed customer UUID |
attributes |
string | Offering attributes (JSON) |
billable |
boolean | Billable |
can_create_offering_user |
boolean | |
category_group_uuid |
string (uuid) | Category group UUID |
category_uuid |
string (uuid) | Category UUID |
created |
string (date-time) | Created after |
customer |
string (uri) | Customer URL |
customer_uuid |
string (uuid) | Customer UUID |
description |
string | Description contains |
end |
string | End date in format YYYY-MM. |
has_active_terms_of_service |
boolean | Has Active Terms of Service |
has_terms_of_service |
boolean | Has Terms of Service |
importable |
string | Filter by importable offerings. |
keyword |
string | Keyword |
modified |
string (date-time) | Modified after |
name |
string | Name |
name_exact |
string | Name (exact) |
o |
array | Ordering |
organization_group_uuid |
string (uuid) | Organization group UUID |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
parent_uuid |
string (uuid) | Parent offering UUID |
project_uuid |
string (uuid) | Project UUID |
query |
string | Search by offering name, slug or description |
resource_customer_uuid |
string (uuid) | Resource customer UUID |
resource_project_uuid |
string (uuid) | Resource project UUID |
scope_uuid |
string | Scope UUID |
service_manager_uuid |
string (uuid) | Service manager UUID |
shared |
boolean | Shared |
start |
string | Start date in format YYYY-MM. |
state |
array | Offering state |
tag |
array | Tag UUID (OR logic) |
tag_name |
array | Tag name (OR logic) |
tag_names_and |
string | Tag names with AND logic (comma-separated) |
tags_and |
string | Tag UUIDs with AND logic (comma-separated) |
type |
array | Offering type |
user_has_consent |
boolean | User Has Consent |
user_has_offering_user |
boolean | User Has Offering User |
uuid_list |
string | Comma-separated offering UUIDs |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
period |
string |
billing_period |
string |
date |
string |
usage |
integer |
description |
string |
measured_unit |
string |
type |
string |
name |
string |
Get costs for an offering
Returns monthly cost data for an offering within a specified date range.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
- Model Source:
OfferingState - Model Source:
ProviderOfferingDetailsOEnum - API Source:
marketplace_provider_offerings_costs_list
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
accessible_via_calls |
boolean | Accessible via calls |
accounting_is_running |
boolean | |
allowed_customer_uuid |
string (uuid) | Allowed customer UUID |
attributes |
string | Offering attributes (JSON) |
billable |
boolean | Billable |
can_create_offering_user |
boolean | |
category_group_uuid |
string (uuid) | Category group UUID |
category_uuid |
string (uuid) | Category UUID |
created |
string (date-time) | Created after |
customer |
string (uri) | Customer URL |
customer_uuid |
string (uuid) | Customer UUID |
description |
string | Description contains |
end |
string | End date in format YYYY-MM. |
has_active_terms_of_service |
boolean | Has Active Terms of Service |
has_terms_of_service |
boolean | Has Terms of Service |
importable |
string | Filter by importable offerings. |
keyword |
string | Keyword |
modified |
string (date-time) | Modified after |
name |
string | Name |
name_exact |
string | Name (exact) |
o |
array | Ordering |
organization_group_uuid |
string (uuid) | Organization group UUID |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
parent_uuid |
string (uuid) | Parent offering UUID |
project_uuid |
string (uuid) | Project UUID |
query |
string | Search by offering name, slug or description |
resource_customer_uuid |
string (uuid) | Resource customer UUID |
resource_project_uuid |
string (uuid) | Resource project UUID |
scope_uuid |
string | Scope UUID |
service_manager_uuid |
string (uuid) | Service manager UUID |
shared |
boolean | Shared |
start |
string | Start date in format YYYY-MM. |
state |
array | Offering state |
tag |
array | Tag UUID (OR logic) |
tag_name |
array | Tag name (OR logic) |
tag_names_and |
string | Tag names with AND logic (comma-separated) |
tags_and |
string | Tag UUIDs with AND logic (comma-separated) |
type |
array | Offering type |
user_has_consent |
boolean | User Has Consent |
user_has_offering_user |
boolean | User Has Offering User |
uuid_list |
string | Comma-separated offering UUIDs |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
period |
string | Billing period (YYYY-MM) |
price |
number (double) | Price amount excluding tax |
tax |
number (double) | Tax amount |
total |
number (double) | Total amount including tax |
Get customers for an offering
Returns a paginated list of customers who have resources for this offering.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
OfferingState - Model Source:
ProviderOfferingCustomerFieldEnum - Model Source:
ProviderOfferingDetailsOEnum - API Source:
marketplace_provider_offerings_customers_list
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
accessible_via_calls |
boolean | Accessible via calls |
allowed_customer_uuid |
string (uuid) | Allowed customer UUID |
attributes |
string | Offering attributes (JSON) |
billable |
boolean | Billable |
can_create_offering_user |
boolean | |
category_group_uuid |
string (uuid) | Category group UUID |
category_uuid |
string (uuid) | Category UUID |
created |
string (date-time) | Created after |
customer |
string (uri) | Customer URL |
customer_uuid |
string (uuid) | Customer UUID |
description |
string | Description contains |
field |
array | |
has_active_terms_of_service |
boolean | Has Active Terms of Service |
has_terms_of_service |
boolean | Has Terms of Service |
importable |
string | Filter by importable offerings. |
keyword |
string | Keyword |
modified |
string (date-time) | Modified after |
name |
string | Name |
name_exact |
string | Name (exact) |
o |
array | Ordering |
organization_group_uuid |
string (uuid) | Organization group UUID |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
parent_uuid |
string (uuid) | Parent offering UUID |
project_uuid |
string (uuid) | Project UUID |
query |
string | Search by offering name, slug or description |
resource_customer_uuid |
string (uuid) | Resource customer UUID |
resource_project_uuid |
string (uuid) | Resource project UUID |
scope_uuid |
string | Scope UUID |
service_manager_uuid |
string (uuid) | Service manager UUID |
shared |
boolean | Shared |
state |
array | Offering state |
tag |
array | Tag UUID (OR logic) |
tag_name |
array | Tag name (OR logic) |
tag_names_and |
string | Tag names with AND logic (comma-separated) |
tags_and |
string | Tag UUIDs with AND logic (comma-separated) |
type |
array | Offering type |
user_has_consent |
boolean | User Has Consent |
user_has_offering_user |
boolean | User Has Offering User |
uuid_list |
string | Comma-separated offering UUIDs |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
uuid |
string (uuid) |
name |
string |
slug |
string |
abbreviation |
string |
phone_number |
string |
email |
string (email) |
List offerings grouped by provider
Returns a paginated list of active, shared offerings grouped by their service provider.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- Model Source:
OfferingState - Model Source:
ProviderOfferingDetailsOEnum - API Source:
marketplace_provider_offerings_groups_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
accessible_via_calls |
boolean | Accessible via calls |
allowed_customer_uuid |
string (uuid) | Allowed customer UUID |
attributes |
string | Offering attributes (JSON) |
billable |
boolean | Billable |
can_create_offering_user |
boolean | |
category_group_uuid |
string (uuid) | Category group UUID |
category_uuid |
string (uuid) | Category UUID |
created |
string (date-time) | Created after |
customer |
string (uri) | Customer URL |
customer_uuid |
string (uuid) | Customer UUID |
description |
string | Description contains |
has_active_terms_of_service |
boolean | Has Active Terms of Service |
has_terms_of_service |
boolean | Has Terms of Service |
keyword |
string | Keyword |
modified |
string (date-time) | Modified after |
name |
string | Name |
name_exact |
string | Name (exact) |
o |
array | Ordering |
organization_group_uuid |
string (uuid) | Organization group UUID |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
parent_uuid |
string (uuid) | Parent offering UUID |
project_uuid |
string (uuid) | Project UUID |
query |
string | Search by offering name, slug or description |
resource_customer_uuid |
string (uuid) | Resource customer UUID |
resource_project_uuid |
string (uuid) | Resource project UUID |
scope_uuid |
string | Scope UUID |
service_manager_uuid |
string (uuid) | Service manager UUID |
shared |
boolean | Shared |
state |
array | Offering state |
tag |
array | Tag UUID (OR logic) |
tag_name |
array | Tag name (OR logic) |
tag_names_and |
string | Tag names with AND logic (comma-separated) |
tags_and |
string | Tag UUIDs with AND logic (comma-separated) |
type |
array | Offering type |
user_has_consent |
boolean | User Has Consent |
user_has_offering_user |
boolean | User Has Offering User |
uuid_list |
string | Comma-separated offering UUIDs |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
customer_name |
string | |
customer_uuid |
string | |
offerings |
array of objects | |
offerings.offering_name |
string | Name of the offering |
offerings.offering_uuid |
string (uuid) | UUID of the offering |
List customer projects for an offering
Returns a paginated list of projects that have consumed resources of this offering.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
- Model Source:
ProjectFieldEnum - API Source:
marketplace_provider_offerings_list_customer_projects_list
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
field |
array | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
slug |
string | URL-friendly identifier. Only editable by staff users. |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_slug |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
description |
string | Project description (HTML content will be sanitized) |
customer_display_billing_info_in_projects |
boolean | |
created |
string (date-time) | |
type |
string (uri) | |
type_name |
string | |
type_uuid |
string (uuid) | |
backend_id |
string | |
start_date |
string (date) | Project start date. Cannot be edited after the start date has arrived. |
end_date |
string (date) | Project end date. Setting this field requires DELETE_PROJECT permission. |
end_date_requested_by |
string (uri) | |
oecd_fos_2007_code |
any | |
oecd_fos_2007_label |
string | Human-readable label for the OECD FOS 2007 classification code |
is_industry |
boolean | |
image |
string (uri) | |
resources_count |
integer | Number of active resources in this project |
max_service_accounts |
integer | Maximum number of service accounts allowed |
kind |
any | |
is_removed |
boolean | |
termination_metadata |
any | Metadata about project termination (read-only) |
staff_notes |
string | Internal notes visible only to staff and support users (HTML content will be sanitized) |
grace_period_days |
integer | Number of extra days after project end date before resources are terminated. Overrides customer-level setting. |
user_email_patterns |
any | |
user_affiliations |
any | |
user_identity_sources |
any | List of allowed identity sources (identity providers). |
project_credit |
number (double) | |
marketplace_resource_count |
object (free-form) | |
billing_price_estimate |
any |
List orders for an offering
Returns a paginated list of orders associated with a specific offering.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
- Model Source:
OrderDetailsFieldEnum - API Source:
marketplace_provider_offerings_orders_list
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
field |
array | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
offering |
string (uri) | |
offering_name |
string | |
offering_uuid |
string (uuid) | |
offering_description |
string | |
offering_image |
string (uri) | |
offering_thumbnail |
string (uri) | |
offering_type |
string | |
offering_shared |
boolean | Accessible to all customers. |
offering_billable |
boolean | Purchase and usage is invoiced. |
offering_plugin_options |
any | Public data used by specific plugin, such as storage mode for OpenStack. |
provider_name |
string | |
provider_uuid |
string (uuid) | |
provider_slug |
string | |
category_title |
string | |
category_uuid |
string (uuid) | |
category_icon |
string (uri) | |
plan |
string (uri) | |
plan_unit |
any | |
plan_name |
string | |
plan_uuid |
string (uuid) | |
plan_description |
string | |
attributes |
any | |
limits |
object (free-form) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
modified |
string (date-time) | |
resource_uuid |
string (uuid) | |
resource_type |
string | |
resource_name |
string | |
cost |
string (decimal) | |
state |
any | |
output |
string | |
marketplace_resource_uuid |
string (uuid) | |
error_message |
string | |
error_traceback |
string | |
callback_url |
string (uri) | |
completed_at |
string (date-time) | |
request_comment |
string | |
attachment |
string (uri) | |
type |
any | |
start_date |
string (date) | Enables delayed processing of resource provisioning order. |
slug |
string | |
url |
string (uri) | |
consumer_reviewed_by |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
consumer_reviewed_by_full_name |
string | |
consumer_reviewed_by_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
consumer_reviewed_at |
string (date-time) | |
provider_reviewed_by |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
provider_reviewed_by_full_name |
string | |
provider_reviewed_by_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
provider_reviewed_at |
string (date-time) | |
created_by_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
created_by_full_name |
string | |
created_by_civil_number |
string | |
created_by_email |
string (email) | |
created_by_organization |
string | |
created_by_organization_registry_code |
string | Company registration code of the user's organization, if known |
customer_name |
string | |
customer_uuid |
string (uuid) | |
customer_slug |
string | |
project_name |
string | |
project_uuid |
string (uuid) | |
project_description |
string | |
project_slug |
string | |
old_plan_name |
string | |
new_plan_name |
string | |
old_plan_uuid |
string (uuid) | |
new_plan_uuid |
string (uuid) | |
old_cost_estimate |
number (double) | |
new_cost_estimate |
string (decimal) | |
can_terminate |
boolean | |
fixed_price |
number (double) | |
activation_price |
number (double) | |
termination_comment |
string | |
backend_id |
string | |
order_subtype |
string | |
provider_message |
string | |
provider_message_url |
string (uri) | |
provider_message_attachment |
string (uri) | |
consumer_message |
string | |
consumer_message_attachment |
string (uri) | |
consumer_rejection_comment |
string | |
provider_rejection_comment |
string | |
issue |
any |
Retrieve a specific order for an offering
Returns details of a specific order associated with an offering.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- API Source:
marketplace_provider_offerings_orders_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Name | Type | Required |
|---|---|---|
order_uuid |
string | ✓ |
uuid |
string | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
offering |
string (uri) | |
offering_name |
string | |
offering_uuid |
string (uuid) | |
offering_description |
string | |
offering_image |
string (uri) | |
offering_thumbnail |
string (uri) | |
offering_type |
string | |
offering_shared |
boolean | Accessible to all customers. |
offering_billable |
boolean | Purchase and usage is invoiced. |
offering_plugin_options |
any | Public data used by specific plugin, such as storage mode for OpenStack. |
provider_name |
string | |
provider_uuid |
string (uuid) | |
provider_slug |
string | |
category_title |
string | |
category_uuid |
string (uuid) | |
category_icon |
string (uri) | |
plan |
string (uri) | |
plan_unit |
any | |
plan_name |
string | |
plan_uuid |
string (uuid) | |
plan_description |
string | |
attributes |
any | |
limits |
object (free-form) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
modified |
string (date-time) | |
resource_uuid |
string (uuid) | |
resource_type |
string | |
resource_name |
string | |
cost |
string (decimal) | |
state |
any | |
output |
string | |
marketplace_resource_uuid |
string (uuid) | |
error_message |
string | |
error_traceback |
string | |
callback_url |
string (uri) | |
completed_at |
string (date-time) | |
request_comment |
string | |
attachment |
string (uri) | |
type |
any | |
start_date |
string (date) | Enables delayed processing of resource provisioning order. |
slug |
string | |
url |
string (uri) | |
consumer_reviewed_by |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
consumer_reviewed_by_full_name |
string | |
consumer_reviewed_by_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
consumer_reviewed_at |
string (date-time) | |
provider_reviewed_by |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
provider_reviewed_by_full_name |
string | |
provider_reviewed_by_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
provider_reviewed_at |
string (date-time) | |
created_by_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
created_by_full_name |
string | |
created_by_civil_number |
string | |
created_by_email |
string (email) | |
created_by_organization |
string | |
created_by_organization_registry_code |
string | Company registration code of the user's organization, if known |
customer_name |
string | |
customer_uuid |
string (uuid) | |
customer_slug |
string | |
project_name |
string | |
project_uuid |
string (uuid) | |
project_description |
string | |
project_slug |
string | |
old_plan_name |
string | |
new_plan_name |
string | |
old_plan_uuid |
string (uuid) | |
new_plan_uuid |
string (uuid) | |
old_cost_estimate |
number (double) | |
new_cost_estimate |
string (decimal) | |
can_terminate |
boolean | |
fixed_price |
number (double) | |
activation_price |
number (double) | |
termination_comment |
string | |
backend_id |
string | |
order_subtype |
string | |
provider_message |
string | |
provider_message_url |
string (uri) | |
provider_message_attachment |
string (uri) | |
consumer_message |
string | |
consumer_message_attachment |
string (uri) | |
consumer_rejection_comment |
string | |
provider_rejection_comment |
string | |
issue |
any |
Get offering statistics
Returns basic statistics for an offering, such as the number of active resources and customers.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_provider_offerings_stats_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
resources_count |
integer |
customers_count |
integer |
Get Terms of Service consent statistics
Returns comprehensive Terms of Service consent statistics for this offering, including user counts, consent rates, and historical data.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
active_users_count |
integer | Number of active users |
total_users_count |
integer | Total number of users |
active_users_percentage |
number (double) | Percentage of active users |
accepted_consents_count |
integer | Number of accepted consents |
revoked_consents_count |
integer | Number of revoked consents |
total_consents_count |
integer | Total number of consents |
revoked_consents_over_time |
array of objects | |
revoked_consents_over_time.date |
string (date) | Date of the data point |
revoked_consents_over_time.count |
integer | Count for the date |
tos_version_adoption |
array of objects | |
tos_version_adoption.version |
string | Version identifier |
tos_version_adoption.users_count |
integer | Number of users on this version |
active_users_over_time |
array of objects | |
active_users_over_time.date |
string (date) | Date of the data point |
active_users_over_time.count |
integer | Count for the date |
accepted_consents_over_time |
array of objects | |
accepted_consents_over_time.date |
string (date) | Date of the data point |
accepted_consents_over_time.count |
integer | Count for the date |
Remote Actions & Sync
List importable resources
Returns a paginated list of resources that can be imported for this offering.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
backend_id |
string | Backend identifier of the resource |
name |
string | Name of the resource |
type |
string | Type of the resource |
description |
string | Description of the resource |
Import a resource
Imports a backend resource into the marketplace.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
ImportResourceRequest - API Source:
marketplace_provider_offerings_import_resource
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
backend_id |
string | ✓ | Backend identifier of the resource |
project |
string (uuid) | ✓ | Target project for the resource |
plan |
string (uuid) | ||
additional_details |
any | Constraints: write-only, default: {} |
200 -
| Field | Type | Description |
|---|---|---|
offering |
string (uri) | |
offering_name |
string | |
offering_uuid |
string (uuid) | |
offering_description |
string | |
offering_image |
string (uri) | |
offering_thumbnail |
string (uri) | |
offering_type |
string | |
offering_shared |
boolean | Accessible to all customers. |
offering_billable |
boolean | Purchase and usage is invoiced. |
offering_plugin_options |
any | Public data used by specific plugin, such as storage mode for OpenStack. |
provider_name |
string | |
provider_uuid |
string (uuid) | |
provider_slug |
string | |
category_title |
string | |
category_uuid |
string (uuid) | |
category_icon |
string (uri) | |
plan |
string (uri) | |
plan_unit |
any | |
plan_name |
string | |
plan_uuid |
string (uuid) | |
plan_description |
string | |
attributes |
object (free-form) | |
limits |
object (free-form) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
modified |
string (date-time) | |
url |
string (uri) | |
scope |
string | |
description |
string | |
state |
any | |
resource_uuid |
string (uuid) | |
backend_id |
string | |
effective_id |
string | |
resource_type |
string | |
project |
string (uri) | |
project_uuid |
string (uuid) | |
project_name |
string | |
project_description |
string | |
project_end_date |
string (date) | The date is inclusive. Once reached, all project resource will be scheduled for termination. |
project_end_date_requested_by |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
offering_slug |
string | |
parent_offering_uuid |
string (uuid) | |
parent_offering_name |
string | |
parent_offering_slug |
string | |
offering_backend_id |
string | |
parent_uuid |
string (uuid) | |
parent_name |
string | |
backend_metadata |
any | |
is_usage_based |
boolean | Returns True if the resource has usage-based components that track variable consumption. |
is_limit_based |
boolean | Returns True if the resource has limit-based components with user-adjustable quotas. |
name |
string | |
slug |
string | URL-friendly identifier. Only editable by staff users. |
current_usages |
object (free-form) | Dictionary mapping component types to their latest reported usage amounts. |
can_terminate |
boolean | |
report |
array of objects | |
report.header |
string | Section header text |
report.body |
string | Section body content |
end_date |
string (date) | The date is inclusive. Once reached, a resource will be scheduled for termination. |
end_date_requested_by |
string (uri) | |
username |
string | |
limit_usage |
object (free-form) | Dictionary mapping limit-based component types to their consumed usage. For monthly periods, maps from current_usages; for longer periods, aggregates historical usage. |
downscaled |
boolean | |
restrict_member_access |
boolean | |
paused |
boolean | |
endpoints |
array of objects | |
endpoints.uuid |
string (uuid) | |
endpoints.name |
string | |
endpoints.url |
string | URL of the access endpoint |
error_message |
string | |
error_traceback |
string | |
options |
any | |
available_actions |
array of strings | |
last_sync |
string (date-time) | |
order_in_progress |
any | |
creation_order |
any | |
service_settings_uuid |
string (uuid) | |
project_slug |
string | |
customer_slug |
string | |
user_requires_reconsent |
boolean | Check if the current user needs to re-consent for this resource's offering. |
renewal_date |
object (free-form) | |
offering_state |
any | |
offering_components |
array of objects | |
offering_components.uuid |
string (uuid) | |
offering_components.billing_type |
string | Enum: fixed, usage, limit, one, few |
offering_components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
offering_components.name |
string | Display name for the measured unit, for example, Floating IP. |
offering_components.description |
string | |
offering_components.measured_unit |
string | Unit of measurement, for example, GB. |
offering_components.unit_factor |
integer | The conversion factor from backend units to measured_unit |
offering_components.limit_period |
any | |
offering_components.limit_amount |
integer | |
offering_components.article_code |
string | |
offering_components.max_value |
integer | |
offering_components.min_value |
integer | |
offering_components.max_available_limit |
integer | |
offering_components.is_boolean |
boolean | |
offering_components.default_limit |
integer | |
offering_components.factor |
integer | |
offering_components.is_builtin |
boolean | |
offering_components.is_prepaid |
boolean | |
offering_components.overage_component |
string (uuid) | |
offering_components.min_prepaid_duration |
integer | |
offering_components.max_prepaid_duration |
integer |
Synchronize offering service settings
Schedules a synchronization task to pull the latest data for the offering's service settings from the backend.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_provider_offerings_sync
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
202 - No response body
Other Actions
Get object state at a specific timestamp
Returns the state of the object as it was at the specified timestamp. Only accessible by staff and support users.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Required | Description |
|---|---|---|---|
timestamp |
string | ✓ | ISO 8601 timestamp to query the object state at |
200 -
| Field | Type | Description |
|---|---|---|
id |
integer | Version ID |
revision_date |
string (date-time) | When this revision was created |
revision_user |
object (free-form) | User who created this revision |
revision_comment |
string | Comment describing the revision |
serialized_data |
object (free-form) | Serialized model fields at this revision |
400 -
404 -
Get version history
Returns the version history for this object. Only accessible by staff and support users.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
- Model Source:
OfferingState - Model Source:
ProviderOfferingDetailsOEnum - API Source:
marketplace_provider_offerings_history_list
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
accessible_via_calls |
boolean | Accessible via calls |
allowed_customer_uuid |
string (uuid) | Allowed customer UUID |
attributes |
string | Offering attributes (JSON) |
billable |
boolean | Billable |
can_create_offering_user |
boolean | |
category_group_uuid |
string (uuid) | Category group UUID |
category_uuid |
string (uuid) | Category UUID |
created |
string (date-time) | Created after |
created_after |
string | Filter versions created after this timestamp (ISO 8601) |
created_before |
string | Filter versions created before this timestamp (ISO 8601) |
customer |
string (uri) | Customer URL |
customer_uuid |
string (uuid) | Customer UUID |
description |
string | Description contains |
has_active_terms_of_service |
boolean | Has Active Terms of Service |
has_terms_of_service |
boolean | Has Terms of Service |
importable |
string | Filter by importable offerings. |
keyword |
string | Keyword |
modified |
string (date-time) | Modified after |
name |
string | Name |
name_exact |
string | Name (exact) |
o |
array | Ordering |
organization_group_uuid |
string (uuid) | Organization group UUID |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
parent_uuid |
string (uuid) | Parent offering UUID |
project_uuid |
string (uuid) | Project UUID |
query |
string | Search by offering name, slug or description |
resource_customer_uuid |
string (uuid) | Resource customer UUID |
resource_project_uuid |
string (uuid) | Resource project UUID |
scope_uuid |
string | Scope UUID |
service_manager_uuid |
string (uuid) | Service manager UUID |
shared |
boolean | Shared |
state |
array | Offering state |
tag |
array | Tag UUID (OR logic) |
tag_name |
array | Tag name (OR logic) |
tag_names_and |
string | Tag names with AND logic (comma-separated) |
tags_and |
string | Tag UUIDs with AND logic (comma-separated) |
type |
array | Offering type |
user_has_consent |
boolean | User Has Consent |
user_has_offering_user |
boolean | User Has Offering User |
uuid_list |
string | Comma-separated offering UUIDs |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
id |
integer | Version ID |
revision_date |
string (date-time) | When this revision was created |
revision_user |
object (free-form) | User who created this revision |
revision_comment |
string | Comment describing the revision |
serialized_data |
object (free-form) | Serialized model fields at this revision |
Get user attribute config
Returns the user attribute configuration for this offering, which determines which user attributes are exposed to the service provider.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
created |
string (date-time) | |
modified |
string (date-time) | |
offering_uuid |
string (uuid) | |
offering_name |
string | |
expose_username |
boolean | |
expose_full_name |
boolean | |
expose_email |
boolean | |
expose_phone_number |
boolean | |
expose_organization |
boolean | |
expose_job_title |
boolean | |
expose_affiliations |
boolean | |
expose_gender |
boolean | |
expose_personal_title |
boolean | |
expose_place_of_birth |
boolean | |
expose_country_of_residence |
boolean | |
expose_nationality |
boolean | |
expose_nationalities |
boolean | |
expose_organization_country |
boolean | |
expose_organization_type |
boolean | |
expose_organization_registry_code |
boolean | |
expose_eduperson_assurance |
boolean | |
expose_civil_number |
boolean | |
expose_birth_date |
boolean | |
expose_identity_source |
boolean | |
expose_active_isds |
boolean | |
exposed_fields |
array of strings | Return list of field names currently configured for exposure. |
is_default |
boolean | Return True if this is a default (unsaved) config. |
Check if backend_id is unique
Checks if the provided backend_id has been used in resources of this offering or all offerings of the same customer. Returns true if unique, false if already used.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
CheckUniqueBackendIDRequest - API Source:
marketplace_provider_offerings_check_unique_backend_id
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
backend_id |
string | ✓ | Backend identifier to check |
check_all_offerings |
boolean | Check across all offerings Constraints: default: False |
|
use_offering_rules |
boolean | Apply the offering's backend_id_rules for format and uniqueness validation Constraints: default: False |
200 -
| Field | Type | Description |
|---|---|---|
is_unique |
boolean | Whether the backend ID is unique |
is_valid_format |
boolean | Whether the backend ID matches the offering's format regex (null if no rules configured) |
errors |
array of strings | List of validation error messages |
Delete tags for offering
Removes all tag associations from this offering.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_provider_offerings_delete_tags
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Export offering data
Exports an offering and all its connected parts to YAML format. Allows configuration of which components to include in the export.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
OfferingExportParametersRequest - API Source:
marketplace_provider_offerings_export_offering
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
include_components |
boolean | Include offering components in export Constraints: default: True |
|
include_plans |
boolean | Include offering plans in export Constraints: default: True |
|
include_screenshots |
boolean | Include offering screenshots in export Constraints: default: True |
|
include_files |
boolean | Include offering files in export Constraints: default: True |
|
include_endpoints |
boolean | Include offering access endpoints in export Constraints: default: True |
|
include_organization_groups |
boolean | Include organization groups associations in export Constraints: default: True |
|
include_terms_of_service |
boolean | Include terms of service configurations in export Constraints: default: True |
|
include_plugin_options |
boolean | Include plugin options in export Constraints: default: True |
|
include_secret_options |
boolean | Include secret options in export (WARNING: sensitive data) Constraints: default: False |
|
include_attributes |
boolean | Include offering attributes in export Constraints: default: True |
|
include_options |
boolean | Include offering options in export Constraints: default: True |
|
include_resource_options |
boolean | Include resource options in export Constraints: default: True |
200 -
| Field | Type | Description |
|---|---|---|
offering_uuid |
string (uuid) | UUID of the exported offering |
offering_name |
string | Name of the exported offering |
export_data |
any | Complete export data containing the offering structure |
exported_components |
array of strings | List of exported component types |
export_timestamp |
string (date-time) | Timestamp when the export was completed |
Import offering data
Imports an offering and all its connected parts from YAML format. Allows configuration of which components to import and how to handle conflicts. Imported offerings are always created in DRAFT state for security.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
- Model Source:
OfferingImportParametersRequest - API Source:
marketplace_provider_offerings_import_offering
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Field | Type | Required | Description |
|---|---|---|---|
customer |
string (uuid) | Target customer for imported offering. If not provided, uses current user's customer | |
category |
string | Target category name for imported offering. If not provided, uses category from export data | |
project |
string (uuid) | Target project for imported offering (optional) | |
import_components |
boolean | Import offering components Constraints: default: True |
|
import_plans |
boolean | Import offering plans Constraints: default: True |
|
import_screenshots |
boolean | Import offering screenshots Constraints: default: True |
|
import_files |
boolean | Import offering files Constraints: default: True |
|
import_endpoints |
boolean | Import offering access endpoints Constraints: default: True |
|
import_organization_groups |
boolean | Import organization groups associations (may fail if groups don't exist) Constraints: default: False |
|
import_terms_of_service |
boolean | Import terms of service configurations Constraints: default: True |
|
import_plugin_options |
boolean | Import plugin options Constraints: default: True |
|
import_secret_options |
boolean | Import secret options (WARNING: will overwrite existing secrets) Constraints: default: False |
|
overwrite_existing |
boolean | Overwrite existing offering if one with the same name exists Constraints: default: False |
|
offering_data |
any | ✓ | The exported offering data to import |
200 -
| Field | Type | Description |
|---|---|---|
imported_offering_uuid |
string (uuid) | UUID of the imported offering |
imported_offering_name |
string | Name of the imported offering |
imported_components |
array of strings | List of imported component types |
warnings |
array of strings | List of warnings encountered during import |
import_timestamp |
string (date-time) | Timestamp when the import was completed |
Mark an offering as available
Marks an unavailable offering as available.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_provider_offerings_make_available
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
detail |
string |
state |
string |
Mark an offering as unavailable
Marks an active offering as unavailable, blocking all operations on its resources.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_provider_offerings_make_unavailable
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
detail |
string |
state |
string |
Update offering backend_id rules
Configure validation rules for resource backend_id: format regex and uniqueness scope.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
OfferingBackendIdRulesUpdateRequest - API Source:
marketplace_provider_offerings_update_backend_id_rules
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
backend_id_rules |
any | Validation rules for resource backend_id: format regex and uniqueness scope. |
200 - No response body
Update tags for offering
Sets the list of tags for this offering.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
TagsRequest - API Source:
marketplace_provider_offerings_update_tags
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
tags |
array of string (uuid)s |
200 - No response body
Marketplace Provider Resources
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/marketplace-provider-resources/ |
List provider resources |
| GET | /api/marketplace-provider-resources/{uuid}/ |
Retrieve a provider resource |
| POST | /api/marketplace-provider-resources/{uuid}/pull/ |
Pull resource data |
| POST | /api/marketplace-provider-resources/{uuid}/unlink/ |
Unlink a resource (staff only) |
| POST | /api/marketplace-provider-resources/{uuid}/update_options/ |
Update resource options |
| POST | /api/marketplace-provider-resources/{uuid}/update_options_direct/ |
Update resource options directly |
| PUT | /api/marketplace-provider-resources/{uuid}/ |
Update a provider resource |
| PATCH | /api/marketplace-provider-resources/{uuid}/ |
Partially update a provider resource |
| Other Actions | ||
| GET | /api/marketplace-provider-resources/{uuid}/details/ |
Get resource details |
| GET | /api/marketplace-provider-resources/{uuid}/glauth_users_config/ |
Get GLauth user configuration for a resource |
| GET | /api/marketplace-provider-resources/{uuid}/history/at/ |
Get object state at a specific timestamp |
| GET | /api/marketplace-provider-resources/{uuid}/history/ |
Get version history |
| GET | /api/marketplace-provider-resources/{uuid}/offering_for_subresources/ |
List offerings for sub-resources |
| GET | /api/marketplace-provider-resources/{uuid}/offering/ |
Get offering details |
| GET | /api/marketplace-provider-resources/{uuid}/plan_periods/ |
List resource plan periods |
| GET | /api/marketplace-provider-resources/{uuid}/team/ |
Get resource team |
| POST | /api/marketplace-provider-resources/{uuid}/move_resource/ |
Move a resource to another project |
| POST | /api/marketplace-provider-resources/{uuid}/refresh_last_sync/ |
Refresh last sync time |
| POST | /api/marketplace-provider-resources/{uuid}/restore/ |
Restore |
| POST | /api/marketplace-provider-resources/{uuid}/set_as_erred/ |
Set resource state to erred |
| POST | /api/marketplace-provider-resources/{uuid}/set_as_ok/ |
Set resource state to OK |
| POST | /api/marketplace-provider-resources/{uuid}/set_backend_id/ |
Set resource backend ID |
| POST | /api/marketplace-provider-resources/{uuid}/set_backend_metadata/ |
Set resource backend metadata |
| POST | /api/marketplace-provider-resources/{uuid}/set_downscaled/ |
Set downscaled flag for resource |
| POST | /api/marketplace-provider-resources/{uuid}/set_end_date_by_provider/ |
Set end date by provider |
| POST | /api/marketplace-provider-resources/{uuid}/set_end_date_by_staff/ |
Set end date of the resource by staff |
| POST | /api/marketplace-provider-resources/{uuid}/set_keycloak_scopes/ |
Set Keycloak scope options for a resource |
| POST | /api/marketplace-provider-resources/{uuid}/set_limits/ |
Set resource limits |
| POST | /api/marketplace-provider-resources/{uuid}/set_paused/ |
Set paused flag for resource |
| POST | /api/marketplace-provider-resources/{uuid}/set_restrict_member_access/ |
Set restrict member access flag |
| POST | /api/marketplace-provider-resources/{uuid}/set_slug/ |
Set resource slug |
| POST | /api/marketplace-provider-resources/{uuid}/set_state_ok/ |
Set resource state to OK |
| POST | /api/marketplace-provider-resources/{uuid}/submit_report/ |
Submit a report for a resource |
| POST | /api/marketplace-provider-resources/{uuid}/terminate/ |
Terminate a resource |
Core CRUD
List provider resources
Returns a paginated list of resources for offerings managed by the current user as a service provider.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
- Model Source:
OrderState - Model Source:
ResourceFieldEnum - Model Source:
ResourceOEnum - Model Source:
ResourceState - API Source:
marketplace_provider_resources_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
backend_id |
string | Backend ID |
category_uuid |
string (uuid) | Category UUID |
component_count |
number | Filter by exact number of components |
created |
string (date-time) | Created after |
customer |
string (uri) | Customer URL |
customer_uuid |
string (uuid) | Customer UUID |
downscaled |
boolean | Downscaled |
field |
array | |
has_terminate_date |
boolean | Has termination date |
is_attached |
boolean | Filter by attached state |
lexis_links_supported |
boolean | LEXIS links supported |
limit_based |
boolean | Filter by limit-based offerings |
limit_component_count |
number | Filter by exact number of limit-based components |
modified |
string (date-time) | Modified after |
name |
string | Name |
name_exact |
string | Name (exact) |
o |
array | Ordering |
offering |
string (uri) | |
offering_billable |
boolean | Offering billable |
offering_shared |
boolean | Offering shared |
offering_slug |
array | Multiple values may be separated by commas. |
offering_type |
string | Offering type |
offering_uuid |
array | Multiple values may be separated by commas. |
only_limit_based |
boolean | Filter resources with only limit-based components |
only_usage_based |
boolean | Filter resources with only usage-based components |
order_state |
array | Order state |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
parent_offering_uuid |
string (uuid) | |
paused |
boolean | Paused |
plan_uuid |
string (uuid) | Plan UUID |
project_name |
string | Project name |
project_uuid |
string (uuid) | Project UUID |
provider_uuid |
string (uuid) | Provider UUID |
query |
string | Search by resource UUID, name, slug, backend ID, effective ID, IPs or hypervisor |
restrict_member_access |
boolean | Restrict member access |
runtime_state |
string | Runtime state |
scope |
string (uri) | Filter by scope URL. |
service_manager_uuid |
string (uuid) | Service manager UUID |
state |
array | Resource state |
usage_based |
boolean | Filter by usage-based offerings |
visible_to_providers |
boolean | Include only resources visible to service providers |
visible_to_username |
string | Visible to username |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
offering |
string (uri) | |
offering_name |
string | |
offering_uuid |
string (uuid) | |
offering_description |
string | |
offering_image |
string (uri) | |
offering_thumbnail |
string (uri) | |
offering_type |
string | |
offering_shared |
boolean | Accessible to all customers. |
offering_billable |
boolean | Purchase and usage is invoiced. |
offering_plugin_options |
any | Public data used by specific plugin, such as storage mode for OpenStack. |
provider_name |
string | |
provider_uuid |
string (uuid) | |
provider_slug |
string | |
category_title |
string | |
category_uuid |
string (uuid) | |
category_icon |
string (uri) | |
plan |
string (uri) | |
plan_unit |
any | |
plan_name |
string | |
plan_uuid |
string (uuid) | |
plan_description |
string | |
attributes |
object (free-form) | |
limits |
object (free-form) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
modified |
string (date-time) | |
url |
string (uri) | |
scope |
string | |
description |
string | |
state |
any | |
resource_uuid |
string (uuid) | |
backend_id |
string | |
effective_id |
string | |
resource_type |
string | |
project |
string (uri) | |
project_uuid |
string (uuid) | |
project_name |
string | |
project_description |
string | |
project_end_date |
string (date) | The date is inclusive. Once reached, all project resource will be scheduled for termination. |
project_end_date_requested_by |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
offering_slug |
string | |
parent_offering_uuid |
string (uuid) | |
parent_offering_name |
string | |
parent_offering_slug |
string | |
offering_backend_id |
string | |
parent_uuid |
string (uuid) | |
parent_name |
string | |
backend_metadata |
any | |
is_usage_based |
boolean | Returns True if the resource has usage-based components that track variable consumption. |
is_limit_based |
boolean | Returns True if the resource has limit-based components with user-adjustable quotas. |
name |
string | |
slug |
string | URL-friendly identifier. Only editable by staff users. |
current_usages |
object (free-form) | Dictionary mapping component types to their latest reported usage amounts. |
can_terminate |
boolean | |
report |
array of objects | |
report.header |
string | Section header text |
report.body |
string | Section body content |
end_date |
string (date) | The date is inclusive. Once reached, a resource will be scheduled for termination. |
end_date_requested_by |
string (uri) | |
username |
string | |
limit_usage |
object (free-form) | Dictionary mapping limit-based component types to their consumed usage. For monthly periods, maps from current_usages; for longer periods, aggregates historical usage. |
downscaled |
boolean | |
restrict_member_access |
boolean | |
paused |
boolean | |
endpoints |
array of objects | |
endpoints.uuid |
string (uuid) | |
endpoints.name |
string | |
endpoints.url |
string | URL of the access endpoint |
error_message |
string | |
error_traceback |
string | |
options |
any | |
available_actions |
array of strings | |
last_sync |
string (date-time) | |
order_in_progress |
any | |
creation_order |
any | |
service_settings_uuid |
string (uuid) | |
project_slug |
string | |
customer_slug |
string | |
user_requires_reconsent |
boolean | Check if the current user needs to re-consent for this resource's offering. |
renewal_date |
object (free-form) | |
offering_state |
any | |
offering_components |
array of objects | |
offering_components.uuid |
string (uuid) | |
offering_components.billing_type |
string | Enum: fixed, usage, limit, one, few |
offering_components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
offering_components.name |
string | Display name for the measured unit, for example, Floating IP. |
offering_components.description |
string | |
offering_components.measured_unit |
string | Unit of measurement, for example, GB. |
offering_components.unit_factor |
integer | The conversion factor from backend units to measured_unit |
offering_components.limit_period |
any | |
offering_components.limit_amount |
integer | |
offering_components.article_code |
string | |
offering_components.max_value |
integer | |
offering_components.min_value |
integer | |
offering_components.max_available_limit |
integer | |
offering_components.is_boolean |
boolean | |
offering_components.default_limit |
integer | |
offering_components.factor |
integer | |
offering_components.is_builtin |
boolean | |
offering_components.is_prepaid |
boolean | |
offering_components.overage_component |
string (uuid) | |
offering_components.min_prepaid_duration |
integer | |
offering_components.max_prepaid_duration |
integer |
Retrieve a provider resource
Returns details of a specific resource from a provider's perspective.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
ResourceFieldEnum - API Source:
marketplace_provider_resources_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type | Description |
|---|---|---|
offering |
string (uri) | |
offering_name |
string | |
offering_uuid |
string (uuid) | |
offering_description |
string | |
offering_image |
string (uri) | |
offering_thumbnail |
string (uri) | |
offering_type |
string | |
offering_shared |
boolean | Accessible to all customers. |
offering_billable |
boolean | Purchase and usage is invoiced. |
offering_plugin_options |
any | Public data used by specific plugin, such as storage mode for OpenStack. |
provider_name |
string | |
provider_uuid |
string (uuid) | |
provider_slug |
string | |
category_title |
string | |
category_uuid |
string (uuid) | |
category_icon |
string (uri) | |
plan |
string (uri) | |
plan_unit |
any | |
plan_name |
string | |
plan_uuid |
string (uuid) | |
plan_description |
string | |
attributes |
object (free-form) | |
limits |
object (free-form) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
modified |
string (date-time) | |
url |
string (uri) | |
scope |
string | |
description |
string | |
state |
any | |
resource_uuid |
string (uuid) | |
backend_id |
string | |
effective_id |
string | |
resource_type |
string | |
project |
string (uri) | |
project_uuid |
string (uuid) | |
project_name |
string | |
project_description |
string | |
project_end_date |
string (date) | The date is inclusive. Once reached, all project resource will be scheduled for termination. |
project_end_date_requested_by |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
offering_slug |
string | |
parent_offering_uuid |
string (uuid) | |
parent_offering_name |
string | |
parent_offering_slug |
string | |
offering_backend_id |
string | |
parent_uuid |
string (uuid) | |
parent_name |
string | |
backend_metadata |
any | |
is_usage_based |
boolean | Returns True if the resource has usage-based components that track variable consumption. |
is_limit_based |
boolean | Returns True if the resource has limit-based components with user-adjustable quotas. |
name |
string | |
slug |
string | URL-friendly identifier. Only editable by staff users. |
current_usages |
object (free-form) | Dictionary mapping component types to their latest reported usage amounts. |
can_terminate |
boolean | |
report |
array of objects | |
report.header |
string | Section header text |
report.body |
string | Section body content |
end_date |
string (date) | The date is inclusive. Once reached, a resource will be scheduled for termination. |
end_date_requested_by |
string (uri) | |
username |
string | |
limit_usage |
object (free-form) | Dictionary mapping limit-based component types to their consumed usage. For monthly periods, maps from current_usages; for longer periods, aggregates historical usage. |
downscaled |
boolean | |
restrict_member_access |
boolean | |
paused |
boolean | |
endpoints |
array of objects | |
endpoints.uuid |
string (uuid) | |
endpoints.name |
string | |
endpoints.url |
string | URL of the access endpoint |
error_message |
string | |
error_traceback |
string | |
options |
any | |
available_actions |
array of strings | |
last_sync |
string (date-time) | |
order_in_progress |
any | |
creation_order |
any | |
service_settings_uuid |
string (uuid) | |
project_slug |
string | |
customer_slug |
string | |
user_requires_reconsent |
boolean | Check if the current user needs to re-consent for this resource's offering. |
renewal_date |
object (free-form) | |
offering_state |
any | |
offering_components |
array of objects | |
offering_components.uuid |
string (uuid) | |
offering_components.billing_type |
string | Enum: fixed, usage, limit, one, few |
offering_components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
offering_components.name |
string | Display name for the measured unit, for example, Floating IP. |
offering_components.description |
string | |
offering_components.measured_unit |
string | Unit of measurement, for example, GB. |
offering_components.unit_factor |
integer | The conversion factor from backend units to measured_unit |
offering_components.limit_period |
any | |
offering_components.limit_amount |
integer | |
offering_components.article_code |
string | |
offering_components.max_value |
integer | |
offering_components.min_value |
integer | |
offering_components.max_available_limit |
integer | |
offering_components.is_boolean |
boolean | |
offering_components.default_limit |
integer | |
offering_components.factor |
integer | |
offering_components.is_builtin |
boolean | |
offering_components.is_prepaid |
boolean | |
offering_components.overage_component |
string (uuid) | |
offering_components.min_prepaid_duration |
integer | |
offering_components.max_prepaid_duration |
integer |
Pull resource data
Schedules a task to pull the latest data for the resource from its backend.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_provider_resources_pull
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
202 -
| Field | Type |
|---|---|
detail |
string |
Unlink a resource (staff only)
Forcefully deletes a marketplace resource and its related plugin resource from the database. This action does not schedule operations on the backend and is intended for cleaning up resources stuck in transitioning states. Requires staff permissions.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_provider_resources_unlink
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
403 - No response body
Update resource options
Updates the options of a resource. If the offering is configured to create orders for option changes, a new UPDATE order will be created. Otherwise, the options are updated directly.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
ResourceOptionsRequest - API Source:
marketplace_provider_resources_update_options
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
options |
any |
200 -
| Field | Type | Description |
|---|---|---|
status |
string | Status of the resource response |
201 -
| Field | Type | Description |
|---|---|---|
order_uuid |
string (uuid) | UUID of the created or updated order |
409 - No response body
Update resource options directly
Allows a service provider to directly update the options of a resource without creating an order. This is typically used for administrative changes or backend synchronization.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
ResourceOptionsRequest - API Source:
marketplace_provider_resources_update_options_direct
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
options |
any |
200 -
| Field | Type | Description |
|---|---|---|
status |
string | Status of the resource response |
Update a provider resource
Updates the name or description of a resource. Requires provider permissions.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
ResourceUpdateRequest - API Source:
marketplace_provider_resources_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ✓ | |
description |
string | ||
end_date |
string (date) | The date is inclusive. Once reached, a resource will be scheduled for termination. |
200 -
| Field | Type | Description |
|---|---|---|
name |
string | |
description |
string | |
end_date |
string (date) | The date is inclusive. Once reached, a resource will be scheduled for termination. |
Partially update a provider resource
Partially updates the name or description of a resource. Requires provider permissions.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedResourceUpdateRequest - API Source:
marketplace_provider_resources_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ||
description |
string | ||
end_date |
string (date) | The date is inclusive. Once reached, a resource will be scheduled for termination. |
200 -
| Field | Type | Description |
|---|---|---|
name |
string | |
description |
string | |
end_date |
string (date) | The date is inclusive. Once reached, a resource will be scheduled for termination. |
Other Actions
Get resource details
Returns the detailed representation of the backend resource associated with the marketplace resource. The format of the response depends on the resource type.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_provider_resources_details_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
204 -
404 -
Get GLauth user configuration for a resource
1 2 | |
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
Get object state at a specific timestamp
Returns the state of the object as it was at the specified timestamp. Only accessible by staff and support users.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Required | Description |
|---|---|---|---|
timestamp |
string | ✓ | ISO 8601 timestamp to query the object state at |
200 -
| Field | Type | Description |
|---|---|---|
id |
integer | Version ID |
revision_date |
string (date-time) | When this revision was created |
revision_user |
object (free-form) | User who created this revision |
revision_comment |
string | Comment describing the revision |
serialized_data |
object (free-form) | Serialized model fields at this revision |
400 -
404 -
Get version history
Returns the version history for this object. Only accessible by staff and support users.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
OrderState - Model Source:
ResourceOEnum - Model Source:
ResourceState - API Source:
marketplace_provider_resources_history_list
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
backend_id |
string | Backend ID |
category_uuid |
string (uuid) | Category UUID |
component_count |
number | Filter by exact number of components |
created |
string (date-time) | Created after |
created_after |
string | Filter versions created after this timestamp (ISO 8601) |
created_before |
string | Filter versions created before this timestamp (ISO 8601) |
customer |
string (uri) | Customer URL |
customer_uuid |
string (uuid) | Customer UUID |
downscaled |
boolean | Downscaled |
has_terminate_date |
boolean | Has termination date |
is_attached |
boolean | Filter by attached state |
lexis_links_supported |
boolean | LEXIS links supported |
limit_based |
boolean | Filter by limit-based offerings |
limit_component_count |
number | Filter by exact number of limit-based components |
modified |
string (date-time) | Modified after |
name |
string | Name |
name_exact |
string | Name (exact) |
o |
array | Ordering |
offering |
string (uri) | |
offering_billable |
boolean | Offering billable |
offering_shared |
boolean | Offering shared |
offering_slug |
array | Multiple values may be separated by commas. |
offering_type |
string | Offering type |
offering_uuid |
array | Multiple values may be separated by commas. |
only_limit_based |
boolean | Filter resources with only limit-based components |
only_usage_based |
boolean | Filter resources with only usage-based components |
order_state |
array | Order state |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
parent_offering_uuid |
string (uuid) | |
paused |
boolean | Paused |
plan_uuid |
string (uuid) | Plan UUID |
project_name |
string | Project name |
project_uuid |
string (uuid) | Project UUID |
provider_uuid |
string (uuid) | Provider UUID |
query |
string | Search by resource UUID, name, slug, backend ID, effective ID, IPs or hypervisor |
restrict_member_access |
boolean | Restrict member access |
runtime_state |
string | Runtime state |
scope |
string (uri) | Filter by scope URL. |
service_manager_uuid |
string (uuid) | Service manager UUID |
state |
array | Resource state |
usage_based |
boolean | Filter by usage-based offerings |
visible_to_providers |
boolean | Include only resources visible to service providers |
visible_to_username |
string | Visible to username |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
id |
integer | Version ID |
revision_date |
string (date-time) | When this revision was created |
revision_user |
object (free-form) | User who created this revision |
revision_comment |
string | Comment describing the revision |
serialized_data |
object (free-form) | Serialized model fields at this revision |
List offerings for sub-resources
Returns a list of offerings that can be provisioned as sub-resources of the current resource.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | UUID of the offering |
type |
string | Type of the offering |
Get offering details
Returns details of the offering connected to the requested object.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_provider_resources_offering_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
name |
string | |
slug |
string | URL-friendly identifier. Only editable by staff users. |
description |
string | |
full_description |
string | |
privacy_policy_link |
string (uri) | |
access_url |
string (uri) | Publicly accessible offering access URL |
endpoints |
array of objects | |
endpoints.uuid |
string (uuid) | |
endpoints.name |
string | |
endpoints.url |
string | URL of the access endpoint |
software_catalogs |
array of objects | |
software_catalogs.uuid |
string (uuid) | |
software_catalogs.catalog |
any | |
software_catalogs.enabled_cpu_family |
any | List of enabled CPU families: ['x86_64', 'aarch64'] |
software_catalogs.enabled_cpu_microarchitectures |
any | List of enabled CPU microarchitectures: ['generic', 'zen3'] |
software_catalogs.package_count |
integer | |
software_catalogs.partition |
any | |
partitions |
array of objects | |
partitions.uuid |
string (uuid) | |
partitions.partition_name |
string | Name of the SLURM partition |
partitions.cpu_bind |
integer | Default task binding policy (SLURM cpu_bind) |
partitions.def_cpu_per_gpu |
integer | Default CPUs allocated per GPU |
partitions.max_cpus_per_node |
integer | Maximum allocated CPUs per node |
partitions.max_cpus_per_socket |
integer | Maximum allocated CPUs per socket |
partitions.def_mem_per_cpu |
integer (int64) | Default memory per CPU in MB |
partitions.def_mem_per_gpu |
integer (int64) | Default memory per GPU in MB |
partitions.def_mem_per_node |
integer (int64) | Default memory per node in MB |
partitions.max_mem_per_cpu |
integer (int64) | Maximum memory per CPU in MB |
partitions.max_mem_per_node |
integer (int64) | Maximum memory per node in MB |
partitions.default_time |
integer | Default time limit in minutes |
partitions.max_time |
integer | Maximum time limit in minutes |
partitions.grace_time |
integer | Preemption grace time in seconds |
partitions.max_nodes |
integer | Maximum nodes per job |
partitions.min_nodes |
integer | Minimum nodes per job |
partitions.exclusive_topo |
boolean | Exclusive topology access required |
partitions.exclusive_user |
boolean | Exclusive user access required |
partitions.priority_tier |
integer | Priority tier for scheduling and preemption |
partitions.qos |
string | Quality of Service (QOS) name |
partitions.req_resv |
boolean | Require reservation for job allocation |
roles |
array of objects | |
roles.uuid |
string (uuid) | |
roles.name |
string | |
roles.url |
string (uri) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
project |
string (uri) | |
project_uuid |
string (uuid) | |
project_name |
string | |
category |
string (uri) | |
category_uuid |
string (uuid) | |
category_title |
string | |
attributes |
object (free-form) | |
options |
any | |
resource_options |
any | |
components |
array of objects | |
components.uuid |
string (uuid) | |
components.billing_type |
string | Enum: fixed, usage, limit, one, few |
components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
components.name |
string | Display name for the measured unit, for example, Floating IP. |
components.description |
string | |
components.measured_unit |
string | Unit of measurement, for example, GB. |
components.unit_factor |
integer | The conversion factor from backend units to measured_unit |
components.limit_period |
any | |
components.limit_amount |
integer | |
components.article_code |
string | |
components.max_value |
integer | |
components.min_value |
integer | |
components.max_available_limit |
integer | |
components.is_boolean |
boolean | |
components.default_limit |
integer | |
components.factor |
integer | |
components.is_builtin |
boolean | |
components.is_prepaid |
boolean | |
components.overage_component |
string (uuid) | |
components.min_prepaid_duration |
integer | |
components.max_prepaid_duration |
integer | |
plugin_options |
any | |
state |
any | |
vendor_details |
string | |
getting_started |
string | |
integration_guide |
string | |
thumbnail |
string (uri) | |
order_count |
integer | |
plans |
array of objects | |
plans.url |
string (uri) | |
plans.uuid |
string (uuid) | |
plans.name |
string | |
plans.description |
string | |
plans.article_code |
string | |
plans.max_amount |
integer | Maximum number of plans that could be active. Plan is disabled when maximum amount is reached. |
plans.archived |
boolean | Forbids creation of new resources. |
plans.is_active |
boolean | |
plans.unit_price |
string (decimal) | |
plans.unit |
string | Enum: month, quarter, half_month, day, hour, quantity |
plans.init_price |
number (double) | |
plans.switch_price |
number (double) | |
plans.backend_id |
string | |
plans.organization_groups |
array of objects | |
plans.organization_groups.uuid |
string (uuid) | |
plans.organization_groups.url |
string (uri) | |
plans.organization_groups.name |
string | |
plans.organization_groups.parent_uuid |
string (uuid) | UUID of the parent organization group |
plans.organization_groups.parent_name |
string | Name of the parent organization group |
plans.organization_groups.parent |
string (uri) | |
plans.organization_groups.customers_count |
integer | Number of customers in this organization group |
plans.components |
array of objects | |
plans.components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
plans.components.name |
string | Display name for the measured unit, for example, Floating IP. |
plans.components.measured_unit |
string | Unit of measurement, for example, GB. |
plans.components.amount |
integer | |
plans.components.price |
string (decimal) | |
plans.components.future_price |
string (decimal) | |
plans.components.discount_threshold |
integer | Minimum amount to be eligible for discount. |
plans.components.discount_rate |
integer | Discount rate in percentage. |
plans.prices |
object (free-form) | |
plans.future_prices |
object (free-form) | |
plans.quotas |
object (free-form) | |
plans.resources_count |
integer | |
plans.plan_type |
string | |
plans.minimal_price |
number (double) | |
screenshots |
array of objects | |
screenshots.name |
string | |
screenshots.uuid |
string (uuid) | |
screenshots.description |
string | |
screenshots.image |
string (uri) | |
screenshots.thumbnail |
string (uri) | |
screenshots.created |
string (date-time) | |
type |
string | |
shared |
boolean | Accessible to all customers. |
billable |
boolean | Purchase and usage is invoiced. |
scope |
string | |
scope_uuid |
string (uuid) | |
scope_name |
string (uuid) | |
scope_state |
any | |
scope_error_message |
string | |
files |
array of objects | |
files.name |
string | |
files.created |
string (date-time) | |
files.file |
string (uri) | |
quotas |
array of objects | |
quotas.name |
string | |
quotas.usage |
integer | |
quotas.limit |
integer | |
paused_reason |
string | |
datacite_doi |
string | |
citation_count |
integer | Number of citations of a DOI |
latitude |
number (double) | |
longitude |
number (double) | |
country |
any | Country code (ISO 3166-1 alpha-2) |
backend_id |
string | |
organization_groups |
array of objects | |
organization_groups.uuid |
string (uuid) | |
organization_groups.url |
string (uri) | |
organization_groups.name |
string | |
organization_groups.parent_uuid |
string (uuid) | UUID of the parent organization group |
organization_groups.parent_name |
string | Name of the parent organization group |
organization_groups.parent |
string (uri) | |
organization_groups.customers_count |
integer | Number of customers in this organization group |
tags |
array of objects | |
tags.uuid |
string (uuid) | |
tags.name |
string | |
image |
string (uri) | |
total_customers |
integer | |
total_cost |
integer | |
total_cost_estimated |
integer | |
parent_description |
string | |
parent_uuid |
string (uuid) | |
parent_name |
string | |
backend_metadata |
any | |
has_compliance_requirements |
boolean | |
billing_type_classification |
string | Classify offering components by billing type. Returns 'limit_only', 'usage_only', or 'mixed'. |
compliance_checklist |
string (uri) | |
user_has_consent |
boolean | |
is_accessible |
boolean | |
google_calendar_is_public |
boolean | |
google_calendar_link |
string | Get the Google Calendar link for an offering. |
promotion_campaigns |
array of objects | |
promotion_campaigns.uuid |
string (uuid) | |
promotion_campaigns.name |
string | |
promotion_campaigns.start_date |
string (date) | Starting from this date, the campaign is active. |
promotion_campaigns.end_date |
string (date) | The last day the campaign is active. |
promotion_campaigns.discount_type |
string | Enum: discount, special_price |
promotion_campaigns.discount |
integer | |
promotion_campaigns.stock |
integer | |
promotion_campaigns.description |
string | |
promotion_campaigns.months |
integer | How many months in a row should the related service (when activated) get special deal (0 for indefinitely until active) |
promotion_campaigns.service_provider |
string (uri) |
List resource plan periods
Returns a list of active and future plan periods for the resource. Each period includes the plan details and current component usage.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- API Source:
marketplace_provider_resources_plan_periods_list
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
plan_name |
string | |
plan_uuid |
string (uuid) | |
start |
string (date-time) | |
end |
string (date-time) | |
components |
array of objects | |
components.uuid |
string (uuid) | |
components.created |
string (date-time) | |
components.description |
string | |
components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
components.name |
string | Display name for the measured unit, for example, Floating IP. |
components.measured_unit |
string | Unit of measurement, for example, GB. |
components.usage |
string (decimal) | |
components.date |
string (date-time) | |
components.recurring |
boolean | Reported value is reused every month until changed. |
Get resource team
Returns a list of users connected to the project of this resource, including their project roles and offering-specific usernames.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- API Source:
marketplace_provider_resources_team_list
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
full_name |
string | |
email |
string (email) | |
role |
string | |
expiration_time |
string (date-time) | |
offering_user_username |
string | |
offering_user_state |
any |
Move a resource to another project
Moves a resource and its associated data to a different project. Requires staff permissions.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
MoveResourceRequest - API Source:
marketplace_provider_resources_move_resource
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
project |
any | ✓ | Target project URL where the resource should be moved Constraints: write-only |
200 -
| Field | Type | Description |
|---|---|---|
offering |
string (uri) | |
offering_name |
string | |
offering_uuid |
string (uuid) | |
offering_description |
string | |
offering_image |
string (uri) | |
offering_thumbnail |
string (uri) | |
offering_type |
string | |
offering_shared |
boolean | Accessible to all customers. |
offering_billable |
boolean | Purchase and usage is invoiced. |
offering_plugin_options |
any | Public data used by specific plugin, such as storage mode for OpenStack. |
provider_name |
string | |
provider_uuid |
string (uuid) | |
provider_slug |
string | |
category_title |
string | |
category_uuid |
string (uuid) | |
category_icon |
string (uri) | |
plan |
string (uri) | |
plan_unit |
any | |
plan_name |
string | |
plan_uuid |
string (uuid) | |
plan_description |
string | |
attributes |
object (free-form) | |
limits |
object (free-form) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
modified |
string (date-time) | |
url |
string (uri) | |
scope |
string | |
description |
string | |
state |
any | |
resource_uuid |
string (uuid) | |
backend_id |
string | |
effective_id |
string | |
resource_type |
string | |
project |
string (uri) | |
project_uuid |
string (uuid) | |
project_name |
string | |
project_description |
string | |
project_end_date |
string (date) | The date is inclusive. Once reached, all project resource will be scheduled for termination. |
project_end_date_requested_by |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
offering_slug |
string | |
parent_offering_uuid |
string (uuid) | |
parent_offering_name |
string | |
parent_offering_slug |
string | |
offering_backend_id |
string | |
parent_uuid |
string (uuid) | |
parent_name |
string | |
backend_metadata |
any | |
is_usage_based |
boolean | Returns True if the resource has usage-based components that track variable consumption. |
is_limit_based |
boolean | Returns True if the resource has limit-based components with user-adjustable quotas. |
name |
string | |
slug |
string | URL-friendly identifier. Only editable by staff users. |
current_usages |
object (free-form) | Dictionary mapping component types to their latest reported usage amounts. |
can_terminate |
boolean | |
report |
array of objects | |
report.header |
string | Section header text |
report.body |
string | Section body content |
end_date |
string (date) | The date is inclusive. Once reached, a resource will be scheduled for termination. |
end_date_requested_by |
string (uri) | |
username |
string | |
limit_usage |
object (free-form) | Dictionary mapping limit-based component types to their consumed usage. For monthly periods, maps from current_usages; for longer periods, aggregates historical usage. |
downscaled |
boolean | |
restrict_member_access |
boolean | |
paused |
boolean | |
endpoints |
array of objects | |
endpoints.uuid |
string (uuid) | |
endpoints.name |
string | |
endpoints.url |
string | URL of the access endpoint |
error_message |
string | |
error_traceback |
string | |
options |
any | |
available_actions |
array of strings | |
last_sync |
string (date-time) | |
order_in_progress |
any | |
creation_order |
any | |
service_settings_uuid |
string (uuid) | |
project_slug |
string | |
customer_slug |
string | |
user_requires_reconsent |
boolean | Check if the current user needs to re-consent for this resource's offering. |
renewal_date |
object (free-form) | |
offering_state |
any | |
offering_components |
array of objects | |
offering_components.uuid |
string (uuid) | |
offering_components.billing_type |
string | Enum: fixed, usage, limit, one, few |
offering_components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
offering_components.name |
string | Display name for the measured unit, for example, Floating IP. |
offering_components.description |
string | |
offering_components.measured_unit |
string | Unit of measurement, for example, GB. |
offering_components.unit_factor |
integer | The conversion factor from backend units to measured_unit |
offering_components.limit_period |
any | |
offering_components.limit_amount |
integer | |
offering_components.article_code |
string | |
offering_components.max_value |
integer | |
offering_components.min_value |
integer | |
offering_components.max_available_limit |
integer | |
offering_components.is_boolean |
boolean | |
offering_components.default_limit |
integer | |
offering_components.factor |
integer | |
offering_components.is_builtin |
boolean | |
offering_components.is_prepaid |
boolean | |
offering_components.overage_component |
string (uuid) | |
offering_components.min_prepaid_duration |
integer | |
offering_components.max_prepaid_duration |
integer |
Refresh last sync time
Updates the 'last_sync' timestamp for a resource to the current time. This is useful for backend agents to signal that a resource is being actively monitored.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_provider_resources_refresh_last_sync
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - No response body
Restore
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
ResourceRequest - API Source:
marketplace_provider_resources_restore
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
offering |
string (uri) | ✓ | |
plan |
string (uri) | ||
name |
string | ✓ | |
slug |
string | URL-friendly identifier. Only editable by staff users. | |
end_date |
string (date) | The date is inclusive. Once reached, a resource will be scheduled for termination. | |
downscaled |
boolean | ||
paused |
boolean |
200 -
| Field | Type | Description |
|---|---|---|
offering |
string (uri) | |
offering_name |
string | |
offering_uuid |
string (uuid) | |
offering_description |
string | |
offering_image |
string (uri) | |
offering_thumbnail |
string (uri) | |
offering_type |
string | |
offering_shared |
boolean | Accessible to all customers. |
offering_billable |
boolean | Purchase and usage is invoiced. |
offering_plugin_options |
any | Public data used by specific plugin, such as storage mode for OpenStack. |
provider_name |
string | |
provider_uuid |
string (uuid) | |
provider_slug |
string | |
category_title |
string | |
category_uuid |
string (uuid) | |
category_icon |
string (uri) | |
plan |
string (uri) | |
plan_unit |
any | |
plan_name |
string | |
plan_uuid |
string (uuid) | |
plan_description |
string | |
attributes |
object (free-form) | |
limits |
object (free-form) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
modified |
string (date-time) | |
url |
string (uri) | |
scope |
string | |
description |
string | |
state |
any | |
resource_uuid |
string (uuid) | |
backend_id |
string | |
effective_id |
string | |
resource_type |
string | |
project |
string (uri) | |
project_uuid |
string (uuid) | |
project_name |
string | |
project_description |
string | |
project_end_date |
string (date) | The date is inclusive. Once reached, all project resource will be scheduled for termination. |
project_end_date_requested_by |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
offering_slug |
string | |
parent_offering_uuid |
string (uuid) | |
parent_offering_name |
string | |
parent_offering_slug |
string | |
offering_backend_id |
string | |
parent_uuid |
string (uuid) | |
parent_name |
string | |
backend_metadata |
any | |
is_usage_based |
boolean | Returns True if the resource has usage-based components that track variable consumption. |
is_limit_based |
boolean | Returns True if the resource has limit-based components with user-adjustable quotas. |
name |
string | |
slug |
string | URL-friendly identifier. Only editable by staff users. |
current_usages |
object (free-form) | Dictionary mapping component types to their latest reported usage amounts. |
can_terminate |
boolean | |
report |
array of objects | |
report.header |
string | Section header text |
report.body |
string | Section body content |
end_date |
string (date) | The date is inclusive. Once reached, a resource will be scheduled for termination. |
end_date_requested_by |
string (uri) | |
username |
string | |
limit_usage |
object (free-form) | Dictionary mapping limit-based component types to their consumed usage. For monthly periods, maps from current_usages; for longer periods, aggregates historical usage. |
downscaled |
boolean | |
restrict_member_access |
boolean | |
paused |
boolean | |
endpoints |
array of objects | |
endpoints.uuid |
string (uuid) | |
endpoints.name |
string | |
endpoints.url |
string | URL of the access endpoint |
error_message |
string | |
error_traceback |
string | |
options |
any | |
available_actions |
array of strings | |
last_sync |
string (date-time) | |
order_in_progress |
any | |
creation_order |
any | |
service_settings_uuid |
string (uuid) | |
project_slug |
string | |
customer_slug |
string | |
user_requires_reconsent |
boolean | Check if the current user needs to re-consent for this resource's offering. |
renewal_date |
object (free-form) | |
offering_state |
any | |
offering_components |
array of objects | |
offering_components.uuid |
string (uuid) | |
offering_components.billing_type |
string | Enum: fixed, usage, limit, one, few |
offering_components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
offering_components.name |
string | Display name for the measured unit, for example, Floating IP. |
offering_components.description |
string | |
offering_components.measured_unit |
string | Unit of measurement, for example, GB. |
offering_components.unit_factor |
integer | The conversion factor from backend units to measured_unit |
offering_components.limit_period |
any | |
offering_components.limit_amount |
integer | |
offering_components.article_code |
string | |
offering_components.max_value |
integer | |
offering_components.min_value |
integer | |
offering_components.max_available_limit |
integer | |
offering_components.is_boolean |
boolean | |
offering_components.default_limit |
integer | |
offering_components.factor |
integer | |
offering_components.is_builtin |
boolean | |
offering_components.is_prepaid |
boolean | |
offering_components.overage_component |
string (uuid) | |
offering_components.min_prepaid_duration |
integer | |
offering_components.max_prepaid_duration |
integer |
Set resource state to erred
Allows a service provider to manually set the state of a resource to 'erred'. An error message and traceback can be provided.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
ResourceSetStateErredRequest - API Source:
marketplace_provider_resources_set_as_erred
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
error_message |
string | |
error_traceback |
string |
200 - No response body
Set resource state to OK
Allows a service provider to manually set the state of a resource to 'OK', clearing any previous error messages.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_provider_resources_set_as_ok
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - No response body
Set resource backend ID
Allows a service provider to set or update the backend ID for a resource, linking it to an external system's identifier.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
ResourceBackendIDRequest - API Source:
marketplace_provider_resources_set_backend_id
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
backend_id |
string |
200 -
| Field | Type | Description |
|---|---|---|
status |
string | Status of the resource response |
Set resource backend metadata
Allows a service provider to set or update the backend-specific metadata for a resource.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
ResourceBackendMetadataRequest - API Source:
marketplace_provider_resources_set_backend_metadata
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
backend_metadata |
any | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
status |
string | Status of the resource response |
Set downscaled flag for resource
Sets the 'downscaled' flag for a resource. Requires staff permissions.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
ResourceDownscaledRequest - API Source:
marketplace_provider_resources_set_downscaled
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
downscaled |
boolean |
200 -
| Field | Type |
|---|---|
status |
string |
Set end date by provider
Allows a service provider to set or update the end date for a resource, scheduling it for termination. A notification is sent to the consumer.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
ResourceEndDateByProviderRequest - API Source:
marketplace_provider_resources_set_end_date_by_provider
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
end_date |
string (date) | The date is inclusive. Once reached, a resource will be scheduled for termination. |
200 - No response body
Set end date of the resource by staff
Allows a staff user to set or update the end date for a resource, which will schedule it for termination.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
ResourceEndDateByProviderRequest - API Source:
marketplace_provider_resources_set_end_date_by_staff
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
end_date |
string (date) | The date is inclusive. Once reached, a resource will be scheduled for termination. |
200 - No response body
Set Keycloak scope options for a resource
Allows a service provider to configure available scope options for Keycloak memberships on a resource. Requires Keycloak integration to be enabled on the offering.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
ResourceKeycloakScopesRequest - API Source:
marketplace_provider_resources_set_keycloak_scopes
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
keycloak_available_scopes |
array of objects | ✓ | Pre-configured scope options for this resource. |
keycloak_available_scopes.scope_type |
string | ✓ | Scope type, e.g. 'project', 'cluster'. |
keycloak_available_scopes.scope_id |
string | ✓ | Identifier of the scope (UUID or external ID). |
keycloak_available_scopes.label |
string | ✓ | Human-readable label shown to end users. |
200 -
| Field | Type | Description |
|---|---|---|
status |
string | Status of the resource response |
Set resource limits
Allows a service provider to directly set the limits for a resource. This is typically used for administrative changes or backend synchronization, bypassing the normal order process.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
ResourceSetLimitsRequest - API Source:
marketplace_provider_resources_set_limits
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
limits |
any | ✓ | Dictionary mapping component types to their new limit values |
200 -
| Field | Type | Description |
|---|---|---|
status |
string | Status of the resource response |
Set paused flag for resource
Sets the 'paused' flag for a resource. Requires staff permissions.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
ResourcePausedRequest - API Source:
marketplace_provider_resources_set_paused
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
paused |
boolean |
200 -
| Field | Type |
|---|---|
status |
string |
Set restrict member access flag
Sets the 'restrict_member_access' flag for a resource. Requires staff permissions.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
ResourceRestrictMemberAccessRequest - API Source:
marketplace_provider_resources_set_restrict_member_access
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
restrict_member_access |
boolean |
200 -
| Field | Type |
|---|---|
status |
string |
Set resource slug
Updates the slug for a resource. Requires staff permissions.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
ResourceSlugRequest - API Source:
marketplace_provider_resources_set_slug
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
slug |
string | ✓ |
200 -
| Field | Type |
|---|---|
status |
string |
Set resource state to OK
Allows a service provider to manually set the resource state to OK. This is useful for recovering from Erred state.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_provider_resources_set_state_ok
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
status |
string | Status of the resource response |
Submit a report for a resource
Allows a service provider to submit a report (e.g., usage or status report) for a resource.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
ResourceReportRequest - API Source:
marketplace_provider_resources_submit_report
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
report |
array of objects | ✓ | |
report.header |
string | ✓ | Section header text |
report.body |
string | ✓ | Section body content |
200 -
| Field | Type | Description |
|---|---|---|
status |
string | Status of the resource response |
Terminate a resource
Creates a marketplace order to terminate the resource. This action is asynchronous and may require approval.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
ResourceTerminateRequest - API Source:
marketplace_provider_resources_terminate
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
attributes |
any | Optional attributes/parameters to pass to the termination operation |
200 -
| Field | Type | Description |
|---|---|---|
order_uuid |
string (uuid) | UUID of the created or updated order |
Marketplace Service Providers
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/marketplace-service-providers/{service_provider_uuid}/course_accounts/ |
List course project accounts for a service provider |
| GET | /api/marketplace-service-providers/{service_provider_uuid}/customer_projects/ |
List customer projects of a service provider |
| GET | /api/marketplace-service-providers/{service_provider_uuid}/customers/ |
List customers of a service provider |
| GET | /api/marketplace-service-providers/{service_provider_uuid}/keys/ |
List SSH keys of a service provider |
| GET | /api/marketplace-service-providers/ |
List service providers |
| GET | /api/marketplace-service-providers/{uuid}/list_users/ |
List users and their roles in a scope |
| GET | /api/marketplace-service-providers/{service_provider_uuid}/offerings/ |
List offerings of a service provider |
| GET | /api/marketplace-service-providers/{service_provider_uuid}/project_permissions/ |
List project permissions of a service provider |
| GET | /api/marketplace-service-providers/{service_provider_uuid}/project_service_accounts/ |
List project service accounts for a service provider |
| GET | /api/marketplace-service-providers/{service_provider_uuid}/projects/ |
List projects of a service provider |
| GET | /api/marketplace-service-providers/{uuid}/ |
Retrieve a service provider |
| GET | /api/marketplace-service-providers/{uuid}/revenue/ |
Get service provider revenue |
| GET | /api/marketplace-service-providers/{uuid}/robot_account_customers/ |
List customers with robot accounts |
| GET | /api/marketplace-service-providers/{uuid}/robot_account_projects/ |
List projects with robot accounts |
| GET | /api/marketplace-service-providers/{uuid}/stat/ |
Get service provider statistics |
| GET | /api/marketplace-service-providers/{service_provider_uuid}/user_customers/ |
List customers of a specific user within a service provider's scope |
| GET | /api/marketplace-service-providers/{service_provider_uuid}/users/ |
List users of a service provider |
| GET | /api/marketplace-service-providers/{uuid}/api_secret_code/ |
Get service provider API secret code |
| GET | /api/marketplace-service-providers/{service_provider_uuid}/compliance/checklists_summary/ |
Get summary of compliance checklists |
| GET | /api/marketplace-service-providers/{service_provider_uuid}/compliance/compliance_overview/ |
Get compliance overview for a service provider |
| GET | /api/marketplace-service-providers/{service_provider_uuid}/compliance/offering_users/ |
List offering users' compliance status |
| POST | /api/marketplace-service-providers/{uuid}/add_user/ |
Grant a role to a user |
| POST | /api/marketplace-service-providers/ |
Create a service provider |
| POST | /api/marketplace-service-providers/{uuid}/delete_user/ |
Revoke a role from a user |
| POST | /api/marketplace-service-providers/{uuid}/generate_site_agent_config/ |
Generate site agent configuration |
| POST | /api/marketplace-service-providers/{uuid}/set_offerings_username/ |
Set offering username for a user |
| POST | /api/marketplace-service-providers/{uuid}/update_user/ |
Update a user's role expiration |
| POST | /api/marketplace-service-providers/{uuid}/api_secret_code/ |
Generate new service provider API secret code |
| PUT | /api/marketplace-service-providers/{uuid}/ |
Update a service provider |
| PATCH | /api/marketplace-service-providers/{uuid}/ |
Partially update a service provider |
| DELETE | /api/marketplace-service-providers/{uuid}/ |
Delete a service provider |
List course project accounts for a service provider
Returns a paginated list of course project accounts that have access to resources managed by the provider.
1 2 3 | |
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
- Model Source:
CourseAccountOEnum - Model Source:
ServiceAccountState - API Source:
marketplace_service_providers_course_accounts_list
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
service_provider_uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
email |
string | Email contains |
o |
array | Ordering |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
project_end_date_after |
string (date) | Project end date range |
project_end_date_before |
string (date) | Project end date range |
project_start_date_after |
string (date) | Project start date range |
project_start_date_before |
string (date) | Project start date range |
project_uuid |
string (uuid) | Project UUID |
state |
array | Course account state |
username |
string | Username |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
created |
string (date-time) |
modified |
string (date-time) |
project |
string (uuid) |
project_uuid |
string (uuid) |
project_name |
string |
project_slug |
string |
project_start_date |
string (date) |
project_end_date |
string (date) |
user_uuid |
string (uuid) |
username |
string |
customer_uuid |
string (uuid) |
customer_name |
string |
state |
any |
email |
string (email) |
description |
string |
error_message |
string |
error_traceback |
string |
List customer projects of a service provider
Returns a paginated list of projects belonging to a specific customer that have consumed resources from the specified service provider.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
MarketplaceProviderCustomerProjectFieldEnum - Model Source:
MarketplaceProviderCustomerProjectOEnum - API Source:
marketplace_service_providers_customer_projects_list
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
service_provider_uuid |
string (uuid) | ✓ |
| Name | Type | Required | Description |
|---|---|---|---|
backend_id |
string | ||
can_admin |
boolean | Return a list of projects where current user is admin. | |
can_manage |
boolean | Return a list of projects where current user is manager or a customer owner. | |
conceal_finished_projects |
boolean | Conceal finished projects | |
created |
string (date-time) | Created after | |
customer |
array | Multiple values may be separated by commas. | |
customer_abbreviation |
string | Customer abbreviation | |
customer_name |
string | Customer name | |
customer_native_name |
string | Customer native name | |
description |
string | Description | |
field |
array | ||
is_removed |
boolean | Is removed | |
modified |
string (date-time) | Modified after | |
name |
string | Name | |
name_exact |
string | Name (exact) | |
o |
array | Ordering |
|
page |
integer | A page number within the paginated result set. | |
page_size |
integer | Number of results to return per page. | |
project_customer_uuid |
string (uuid) | ✓ | UUID of the customer to filter projects by. |
query |
string | Filter by name, slug, UUID, backend ID or resource effective ID | |
slug |
string | Slug |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
name |
string | |
description |
string | |
end_date |
string (date) | The date is inclusive. Once reached, all project resource will be scheduled for termination. |
resources_count |
integer | |
users_count |
integer | |
billing_price_estimate |
any |
List customers of a service provider
Returns a paginated list of customers who have consumed resources from the specified service provider.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
- Model Source:
MarketplaceProviderCustomerFieldEnum - API Source:
marketplace_service_providers_customers_list
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
service_provider_uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
abbreviation |
string | Abbreviation |
agreement_number |
string | |
archived |
boolean | |
backend_id |
string | |
contact_details |
string | Contact details |
current_user_has_project_create_permission |
boolean | Return a list of customers where current user has project create permission. |
field |
array | |
name |
string | Name |
name_exact |
string | Name (exact) |
native_name |
string | Native name |
organization_group_name |
string | Organization group name |
organization_group_uuid |
array | Organization group UUID |
owned_by_current_user |
boolean | Return a list of customers where current user is owner. |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
query |
string | Filter by name, native name, abbreviation, domain, UUID, registration code or agreement number |
registration_code |
string |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
uuid |
string (uuid) |
name |
string |
slug |
string |
abbreviation |
string |
phone_number |
string |
email |
string (email) |
payment_profiles |
array of objects |
payment_profiles.uuid |
string (uuid) |
payment_profiles.url |
string (uri) |
payment_profiles.name |
string |
payment_profiles.organization_uuid |
string (uuid) |
payment_profiles.organization |
string (uri) |
payment_profiles.attributes |
object |
payment_profiles.attributes.end_date |
string |
payment_profiles.attributes.agreement_number |
string |
payment_profiles.attributes.contract_sum |
integer |
payment_profiles.payment_type |
string |
payment_profiles.payment_type_display |
string |
payment_profiles.is_active |
boolean |
billing_price_estimate |
any |
projects_count |
integer |
users_count |
integer |
projects |
array of objects |
projects.uuid |
string (uuid) |
projects.name |
string |
projects.image |
string (uri) |
users |
array of objects |
users.uuid |
string (uuid) |
users.full_name |
string |
users.email |
string (email) |
users.image |
string (uri) |
List SSH keys of a service provider
Returns a paginated list of SSH public keys for all users who have consumed resources from the specified service provider.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
- Model Source:
SshKeyFieldEnum - Model Source:
SshKeyOEnum - API Source:
marketplace_service_providers_keys_list
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
service_provider_uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
created |
string (date-time) | Created after |
field |
array | |
fingerprint_md5 |
string | |
fingerprint_sha256 |
string | |
fingerprint_sha512 |
string | |
is_shared |
boolean | |
modified |
string (date-time) | Modified after |
name |
string | Name |
name_exact |
string | Name (exact) |
o |
array | Ordering |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
user_uuid |
string (uuid) | User UUID |
uuid |
string (uuid) | UUID |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
public_key |
string |
fingerprint_md5 |
string |
fingerprint_sha256 |
string |
fingerprint_sha512 |
string |
user_uuid |
string (uuid) |
is_shared |
boolean |
type |
string |
List service providers
Returns a paginated list of service providers.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- Model Source:
CallManagingOrganisationOEnum - Model Source:
ServiceProviderFieldEnum - API Source:
marketplace_service_providers_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
customer |
string (uri) | Customer URL |
customer_keyword |
string | Customer keyword (name, abbreviation or native name) |
customer_uuid |
string (uuid) | Customer UUID |
field |
array | |
o |
array | Ordering |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
description |
string | |
enable_notifications |
boolean | |
customer |
string (uri) | |
customer_name |
string | |
customer_uuid |
string (uuid) | |
customer_image |
string (uri) | |
customer_abbreviation |
string | |
customer_slug |
string | |
customer_native_name |
string | |
customer_country |
string | |
image |
string (uri) | |
organization_groups |
array of objects | |
organization_groups.uuid |
string (uuid) | |
organization_groups.url |
string (uri) | |
organization_groups.name |
string | |
organization_groups.parent_uuid |
string (uuid) | UUID of the parent organization group |
organization_groups.parent_name |
string | Name of the parent organization group |
organization_groups.parent |
string (uri) | |
organization_groups.customers_count |
integer | Number of customers in this organization group |
offering_count |
integer |
List users and their roles in a scope
Retrieves a list of users who have a role within a specific scope (e.g., a project or an organization). The list can be filtered by user details or role.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
- Model Source:
UserRoleDetailsFieldEnum - Model Source:
UserRoleDetailsOEnum - API Source:
marketplace_service_providers_list_users_list
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
field |
array | Fields to include in response |
full_name |
string | User full name |
native_name |
string | User native name |
o |
array | Ordering fields |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
role |
string (uuid) | Role UUID or name |
search_string |
string | Search string for user |
user |
string (uuid) | User UUID |
user_slug |
string | User slug |
user_url |
string | User URL |
username |
string | User username |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
created |
string (date-time) | |
expiration_time |
string (date-time) | |
role_name |
string | |
role_uuid |
string (uuid) | |
user_email |
string (email) | |
user_full_name |
string | |
user_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
user_uuid |
string (uuid) | |
user_image |
string (uri) | |
created_by_full_name |
string | |
created_by_uuid |
string (uuid) |
List offerings of a service provider
Returns a paginated list of all billable, shared offerings provided by the specified service provider.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
OfferingState - Model Source:
ProviderOfferingDetailsOEnum - Model Source:
ProviderOfferingFieldEnum - API Source:
marketplace_service_providers_offerings_list
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
service_provider_uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
accessible_via_calls |
boolean | Accessible via calls |
allowed_customer_uuid |
string (uuid) | Allowed customer UUID |
attributes |
string | Offering attributes (JSON) |
billable |
boolean | Billable |
can_create_offering_user |
boolean | |
category_group_uuid |
string (uuid) | Category group UUID |
category_uuid |
string (uuid) | Category UUID |
created |
string (date-time) | Created after |
customer |
string (uri) | Customer URL |
customer_uuid |
string (uuid) | Customer UUID |
description |
string | Description contains |
field |
array | |
has_active_terms_of_service |
boolean | Has Active Terms of Service |
has_terms_of_service |
boolean | Has Terms of Service |
keyword |
string | Keyword |
modified |
string (date-time) | Modified after |
name |
string | Name |
name_exact |
string | Name (exact) |
o |
array | Ordering |
organization_group_uuid |
string (uuid) | Organization group UUID |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
parent_uuid |
string (uuid) | Parent offering UUID |
project_uuid |
string (uuid) | Project UUID |
query |
string | Search by offering name, slug or description |
resource_customer_uuid |
string (uuid) | Resource customer UUID |
resource_project_uuid |
string (uuid) | Resource project UUID |
scope_uuid |
string | Scope UUID |
service_manager_uuid |
string (uuid) | Service manager UUID |
shared |
boolean | Shared |
state |
array | Offering state |
tag |
array | Tag UUID (OR logic) |
tag_name |
array | Tag name (OR logic) |
tag_names_and |
string | Tag names with AND logic (comma-separated) |
tags_and |
string | Tag UUIDs with AND logic (comma-separated) |
type |
array | Offering type |
user_has_consent |
boolean | User Has Consent |
user_has_offering_user |
boolean | User Has Offering User |
uuid_list |
string | Comma-separated offering UUIDs |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
customer_uuid |
string (uuid) | |
name |
string | |
slug |
string | URL-friendly identifier. Only editable by staff users. |
category_title |
string | |
type |
string | |
state |
any | |
resources_count |
integer | |
billing_price_estimate |
any | |
components |
array of objects | |
components.uuid |
string (uuid) | |
components.billing_type |
string | Enum: fixed, usage, limit, one, few |
components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
components.name |
string | Display name for the measured unit, for example, Floating IP. |
components.description |
string | |
components.measured_unit |
string | Unit of measurement, for example, GB. |
components.unit_factor |
integer | The conversion factor from backend units to measured_unit |
components.limit_period |
any | |
components.limit_amount |
integer | |
components.article_code |
string | |
components.max_value |
integer | |
components.min_value |
integer | |
components.max_available_limit |
integer | |
components.is_boolean |
boolean | |
components.default_limit |
integer | |
components.factor |
integer | |
components.is_builtin |
boolean | |
components.is_prepaid |
boolean | |
components.overage_component |
string (uuid) | |
components.min_prepaid_duration |
integer | |
components.max_prepaid_duration |
integer | |
plans |
array of objects | |
plans.url |
string (uri) | |
plans.uuid |
string (uuid) | |
plans.name |
string | |
plans.description |
string | |
plans.article_code |
string | |
plans.max_amount |
integer | Maximum number of plans that could be active. Plan is disabled when maximum amount is reached. |
plans.archived |
boolean | Forbids creation of new resources. |
plans.is_active |
boolean | |
plans.unit_price |
string (decimal) | |
plans.unit |
string | Enum: month, quarter, half_month, day, hour, quantity |
plans.init_price |
number (double) | |
plans.switch_price |
number (double) | |
plans.backend_id |
string | |
plans.organization_groups |
array of objects | |
plans.organization_groups.uuid |
string (uuid) | |
plans.organization_groups.url |
string (uri) | |
plans.organization_groups.name |
string | |
plans.organization_groups.parent_uuid |
string (uuid) | UUID of the parent organization group |
plans.organization_groups.parent_name |
string | Name of the parent organization group |
plans.organization_groups.parent |
string (uri) | |
plans.organization_groups.customers_count |
integer | Number of customers in this organization group |
plans.components |
array of objects | |
plans.components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
plans.components.name |
string | Display name for the measured unit, for example, Floating IP. |
plans.components.measured_unit |
string | Unit of measurement, for example, GB. |
plans.components.amount |
integer | |
plans.components.price |
string (decimal) | |
plans.components.future_price |
string (decimal) | |
plans.components.discount_threshold |
integer | Minimum amount to be eligible for discount. |
plans.components.discount_rate |
integer | Discount rate in percentage. |
plans.prices |
object (free-form) | |
plans.future_prices |
object (free-form) | |
plans.quotas |
object (free-form) | |
plans.resources_count |
integer | |
plans.plan_type |
string | |
plans.minimal_price |
number (double) | |
options |
any | Fields describing resource provision form. |
resource_options |
any | Fields describing resource report form. |
secret_options |
any | |
thumbnail |
string (uri) |
List project permissions of a service provider
Returns a paginated list of project permissions for all projects that have consumed resources from the specified service provider.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
- Model Source:
OfferingPermissionOEnum - Model Source:
ProjectPermissionLogFieldEnum - API Source:
marketplace_service_providers_project_permissions_list
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
service_provider_uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
created |
string (date-time) | Created after |
expiration_time |
string (date-time) | |
field |
array | |
full_name |
string | User full name contains |
modified |
string (date-time) | Modified after |
native_name |
string | |
o |
array | Ordering |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
role_name |
string | Role name contains |
role_uuid |
string (uuid) | Role UUID |
scope_name |
string | Scope name |
scope_type |
string | Scope type |
scope_uuid |
string | Scope UUID |
user |
string (uuid) | |
user_slug |
string | User slug contains |
user_url |
string (uri) | |
username |
string |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
created |
string (date-time) | |
expiration_time |
string (date-time) | |
created_by |
string (uri) | |
created_by_full_name |
string | |
created_by_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
project |
string (uri) | |
project_uuid |
string (uuid) | |
project_name |
string | |
project_created |
string (date-time) | |
project_end_date |
string (date-time) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
role |
string | |
role_name |
string | |
user |
string (uri) | |
user_full_name |
string | |
user_native_name |
string | |
user_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
user_uuid |
string (uuid) | |
user_email |
string (email) |
List project service accounts for a service provider
Returns a paginated list of project service accounts that have access to resources managed by the provider.
1 2 3 | |
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
- Model Source:
ServiceAccountState - API Source:
marketplace_service_providers_project_service_accounts_list
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
service_provider_uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
email |
string | Email contains |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
project |
string (uri) | Project URL |
project_uuid |
string (uuid) | Project UUID |
state |
array | Service account state |
username |
string | Username |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
created |
string (date-time) |
modified |
string (date-time) |
username |
string |
description |
string |
error_message |
string |
error_traceback |
string |
state |
any |
token |
string |
email |
string (email) |
expires_at |
string |
preferred_identifier |
string |
project |
string (uuid) |
project_uuid |
string (uuid) |
project_name |
string |
customer_uuid |
string (uuid) |
customer_name |
string |
customer_abbreviation |
string |
List projects of a service provider
Returns a paginated list of all projects that have consumed resources from the specified service provider.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
- Model Source:
MarketplaceProviderCustomerProjectOEnum - Model Source:
ProjectFieldEnum - API Source:
marketplace_service_providers_projects_list
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
service_provider_uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
backend_id |
string | |
can_admin |
boolean | Return a list of projects where current user is admin. |
can_manage |
boolean | Return a list of projects where current user is manager or a customer owner. |
conceal_finished_projects |
boolean | Conceal finished projects |
created |
string (date-time) | Created after |
customer |
array | Multiple values may be separated by commas. |
customer_abbreviation |
string | Customer abbreviation |
customer_name |
string | Customer name |
customer_native_name |
string | Customer native name |
description |
string | Description |
field |
array | |
is_removed |
boolean | Is removed |
modified |
string (date-time) | Modified after |
name |
string | Name |
name_exact |
string | Name (exact) |
o |
array | Ordering |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
query |
string | Filter by name, slug, UUID, backend ID or resource effective ID |
slug |
string | Slug |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
slug |
string | URL-friendly identifier. Only editable by staff users. |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
customer_slug |
string | |
customer_native_name |
string | |
customer_abbreviation |
string | |
description |
string | Project description (HTML content will be sanitized) |
customer_display_billing_info_in_projects |
boolean | |
created |
string (date-time) | |
type |
string (uri) | |
type_name |
string | |
type_uuid |
string (uuid) | |
backend_id |
string | |
start_date |
string (date) | Project start date. Cannot be edited after the start date has arrived. |
end_date |
string (date) | Project end date. Setting this field requires DELETE_PROJECT permission. |
end_date_requested_by |
string (uri) | |
oecd_fos_2007_code |
any | |
oecd_fos_2007_label |
string | Human-readable label for the OECD FOS 2007 classification code |
is_industry |
boolean | |
image |
string (uri) | |
resources_count |
integer | Number of active resources in this project |
max_service_accounts |
integer | Maximum number of service accounts allowed |
kind |
any | |
is_removed |
boolean | |
termination_metadata |
any | Metadata about project termination (read-only) |
staff_notes |
string | Internal notes visible only to staff and support users (HTML content will be sanitized) |
grace_period_days |
integer | Number of extra days after project end date before resources are terminated. Overrides customer-level setting. |
user_email_patterns |
any | |
user_affiliations |
any | |
user_identity_sources |
any | List of allowed identity sources (identity providers). |
project_credit |
number (double) | |
marketplace_resource_count |
object (free-form) | |
billing_price_estimate |
any |
Retrieve a service provider
Returns details of a specific service provider.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
ServiceProviderFieldEnum - API Source:
marketplace_service_providers_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
description |
string | |
enable_notifications |
boolean | |
customer |
string (uri) | |
customer_name |
string | |
customer_uuid |
string (uuid) | |
customer_image |
string (uri) | |
customer_abbreviation |
string | |
customer_slug |
string | |
customer_native_name |
string | |
customer_country |
string | |
image |
string (uri) | |
organization_groups |
array of objects | |
organization_groups.uuid |
string (uuid) | |
organization_groups.url |
string (uri) | |
organization_groups.name |
string | |
organization_groups.parent_uuid |
string (uuid) | UUID of the parent organization group |
organization_groups.parent_name |
string | Name of the parent organization group |
organization_groups.parent |
string (uri) | |
organization_groups.customers_count |
integer | Number of customers in this organization group |
offering_count |
integer |
Get service provider revenue
Returns monthly revenue data for the last year for the service provider.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- API Source:
marketplace_service_providers_revenue_list
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
total |
integer | Total revenue amount |
year |
integer | Invoice year |
month |
integer | Invoice month |
List customers with robot accounts
Returns a paginated list of customers who have robot accounts for resources managed by this service provider.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
customer_name |
string | Filter by customer name (case-insensitive partial match). |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
name |
string | Name of the entity |
uuid |
string (uuid) | UUID of the entity |
List projects with robot accounts
Returns a paginated list of projects which have robot accounts for resources managed by this service provider.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
project_name |
string | Filter by project name (case-insensitive partial match). |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
name |
string | Name of the entity |
uuid |
string (uuid) | UUID of the entity |
Get service provider statistics
Returns various statistics for the service provider, such as number of active campaigns, customers, and resources.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_service_providers_stat_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
active_campaigns |
integer | Number of active campaigns |
current_customers |
integer | Number of current customers |
customers_number_change |
integer | Change in number of customers |
active_resources |
integer | Number of active resources |
resources_number_change |
integer | Change in number of resources |
active_and_paused_offerings |
integer | Number of active and paused offerings |
unresolved_tickets |
integer | Number of unresolved support tickets |
pending_orders |
integer | Number of pending orders |
erred_resources |
integer | Number of resources in error state |
List customers of a specific user within a service provider's scope
Returns a paginated list of customers that a specified user has access to within the scope of a service provider.
1 2 3 4 | |
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
- Model Source:
MarketplaceProviderCustomerFieldEnum - API Source:
marketplace_service_providers_user_customers_list
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
service_provider_uuid |
string (uuid) | ✓ |
| Name | Type | Required | Description |
|---|---|---|---|
abbreviation |
string | Abbreviation | |
agreement_number |
string | ||
archived |
boolean | ||
backend_id |
string | ||
contact_details |
string | Contact details | |
current_user_has_project_create_permission |
boolean | Return a list of customers where current user has project create permission. | |
field |
array | ||
name |
string | Name | |
name_exact |
string | Name (exact) | |
native_name |
string | Native name | |
organization_group_name |
string | Organization group name | |
organization_group_uuid |
array | Organization group UUID | |
owned_by_current_user |
boolean | Return a list of customers where current user is owner. | |
page |
integer | A page number within the paginated result set. | |
page_size |
integer | Number of results to return per page. | |
query |
string | Filter by name, native name, abbreviation, domain, UUID, registration code or agreement number | |
registration_code |
string | ||
user_uuid |
string (uuid) | ✓ | UUID of the user to get related customers for. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
uuid |
string (uuid) |
name |
string |
slug |
string |
abbreviation |
string |
phone_number |
string |
email |
string (email) |
payment_profiles |
array of objects |
payment_profiles.uuid |
string (uuid) |
payment_profiles.url |
string (uri) |
payment_profiles.name |
string |
payment_profiles.organization_uuid |
string (uuid) |
payment_profiles.organization |
string (uri) |
payment_profiles.attributes |
object |
payment_profiles.attributes.end_date |
string |
payment_profiles.attributes.agreement_number |
string |
payment_profiles.attributes.contract_sum |
integer |
payment_profiles.payment_type |
string |
payment_profiles.payment_type_display |
string |
payment_profiles.is_active |
boolean |
billing_price_estimate |
any |
projects_count |
integer |
users_count |
integer |
projects |
array of objects |
projects.uuid |
string (uuid) |
projects.name |
string |
projects.image |
string (uri) |
users |
array of objects |
users.uuid |
string (uuid) |
users.full_name |
string |
users.email |
string (email) |
users.image |
string (uri) |
List users of a service provider
Returns a paginated list of all users who have consumed resources from the specified service provider.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
- Model Source:
MarketplaceServiceProviderUserFieldEnum - Model Source:
MarketplaceServiceProviderUserOEnum - API Source:
marketplace_service_providers_users_list
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
service_provider_uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
agreement_date |
string (date-time) | Agreement date after |
civil_number |
string | |
customer_uuid |
string (uuid) | Customer UUID |
date_joined |
string (date-time) | Date joined after |
description |
string | |
email |
string | |
field |
array | |
full_name |
string | Full name |
is_active |
boolean | Is active |
is_staff |
boolean | Is staff |
is_support |
boolean | Is support |
job_title |
string | Job title |
modified |
string (date-time) | Date modified after |
native_name |
string | Native name |
o |
array | Ordering |
organization |
string | Organization |
organization_roles |
string | Organization roles |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
phone_number |
string | |
project_roles |
string | Project roles |
project_uuid |
string (uuid) | Project UUID |
query |
string | Filter by first name, last name, civil number, username or email |
registration_method |
string | |
user_keyword |
string | User keyword |
username |
string | Username (exact) |
username_list |
string | Comma-separated usernames |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
full_name |
string | |
first_name |
string | |
last_name |
string | |
organization |
string | |
email |
string (email) | |
phone_number |
string | |
projects_count |
integer | |
registration_method |
string | Indicates what registration method was used. |
affiliations |
any | Person's affiliation within organization such as student, faculty, staff. |
is_active |
boolean | Designates whether this user should be treated as active. Unselect this instead of deleting accounts. |
job_title |
string | |
gender |
any | ISO 5218 gender code |
personal_title |
string | Honorific title (Mr, Ms, Dr, Prof, etc.) |
place_of_birth |
string | |
country_of_residence |
string | |
nationality |
string | Primary citizenship (ISO 3166-1 alpha-2 code) |
nationalities |
any | List of all citizenships (ISO 3166-1 alpha-2 codes) |
organization_country |
string | |
organization_type |
string | SCHAC URN (e.g., urn:schac:homeOrganizationType:int:university) |
organization_registry_code |
string | Company registration code of the user's organization, if known |
eduperson_assurance |
any | REFEDS assurance profile URIs from identity provider |
civil_number |
string | |
birth_date |
string (date) | |
identity_source |
string | Indicates what identity provider was used. |
active_isds |
any | List of ISDs that have asserted this user exists. User is deactivated when this becomes empty. |
Get service provider API secret code
Returns the API secret code for a service provider. Requires service provider owner permission.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
service_provider_api_secret_code_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
api_secret_code |
string | API secret code for authenticating service provider requests |
Get summary of compliance checklists
Returns a summary of all compliance checklists used by this service provider with usage counts.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- API Source:
service_provider_checklists_summary
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
service_provider_uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
checklist_uuid |
string (uuid) |
checklist_name |
string |
questions_count |
integer |
offerings_count |
integer |
Get compliance overview for a service provider
Returns compliance overview statistics for all offerings managed by this service provider.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- API Source:
service_provider_compliance_overview
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
service_provider_uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
offering_uuid |
string (uuid) |
offering_name |
string |
checklist_name |
string |
total_users |
integer |
users_with_completions |
integer |
completed_users |
integer |
pending_users |
integer |
compliance_rate |
number (double) |
List offering users' compliance status
Returns a list of offering users with their compliance status for this service provider. Can be filtered by offering and compliance status.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- API Source:
service_provider_offering_users_compliance
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
service_provider_uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
compliance_status |
string | Filter by compliance status: completed, pending, no_checklist. |
offering_uuid |
string (uuid) | Filter by offering UUID. |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
uuid |
string (uuid) |
user_full_name |
string |
user_email |
string |
offering_name |
string |
checklist_name |
string |
username |
string |
state |
any |
completion_percentage |
integer |
compliance_status |
string |
last_updated |
string (date-time) |
created |
string (date-time) |
Grant a role to a user
Assigns a specific role to a user within the current scope. An optional expiration time for the role can be set.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
UserRoleCreateRequest - API Source:
marketplace_service_providers_add_user
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
role |
string | ✓ |
user |
string (uuid) | ✓ |
expiration_time |
string (date-time) |
201 -
| Field | Type |
|---|---|
expiration_time |
string (date-time) |
400 - Validation error, for example when trying to add a user to a terminated project.
Create a service provider
Creates a new service provider profile for a customer.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
- Model Source:
ServiceProviderRequest - API Source:
marketplace_service_providers_create
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Field | Type | Required |
|---|---|---|
description |
string | |
enable_notifications |
boolean | |
customer |
string (uri) | ✓ |
image |
string (binary) |
201 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
description |
string | |
enable_notifications |
boolean | |
customer |
string (uri) | |
customer_name |
string | |
customer_uuid |
string (uuid) | |
customer_image |
string (uri) | |
customer_abbreviation |
string | |
customer_slug |
string | |
customer_native_name |
string | |
customer_country |
string | |
image |
string (uri) | |
organization_groups |
array of objects | |
organization_groups.uuid |
string (uuid) | |
organization_groups.url |
string (uri) | |
organization_groups.name |
string | |
organization_groups.parent_uuid |
string (uuid) | UUID of the parent organization group |
organization_groups.parent_name |
string | Name of the parent organization group |
organization_groups.parent |
string (uri) | |
organization_groups.customers_count |
integer | Number of customers in this organization group |
offering_count |
integer |
Revoke a role from a user
Removes a specific role from a user within the current scope. This effectively revokes their permissions associated with that role.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
UserRoleDeleteRequest - API Source:
marketplace_service_providers_delete_user
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
role |
string | ✓ |
user |
string (uuid) | ✓ |
expiration_time |
string (date-time) |
200 - Role revoked successfully.
Generate site agent configuration
Generates a YAML configuration file for waldur-site-agent based on selected SLURM offerings. The configuration includes offering details, components, backend settings, and optionally SLURM periodic usage policy settings. Secrets are shown as placeholders that need to be filled in.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
SiteAgentConfigGenerationRequest - API Source:
marketplace_service_providers_generate_site_agent_config
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
offering_uuids |
array of string (uuid)s | ✓ | List of SLURM offering UUIDs to include in configuration |
include_policy_settings |
boolean | Include SLURM periodic usage policy settings in configuration Constraints: default: True |
|
waldur_api_url |
string (uri) | Waldur API URL (defaults to current server URL) | |
timezone |
string | Timezone for the site agent Constraints: default: UTC |
200 -
Set offering username for a user
Sets or updates the offering-specific username for a user across all offerings managed by the service provider that the user has access to.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
SetOfferingsUsernameRequest - API Source:
marketplace_service_providers_set_offerings_username
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
user_uuid |
string (uuid) | ✓ | UUID of the user |
username |
string | ✓ | Username for offering access |
201 - No response body
Update a user's role expiration
Updates the expiration time for a user's existing role in the current scope. This is useful for extending or shortening the duration of a permission. To make a role permanent, set expiration_time to null.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
UserRoleUpdateRequest - API Source:
marketplace_service_providers_update_user
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
role |
string | ✓ |
user |
string (uuid) | ✓ |
expiration_time |
string (date-time) |
200 -
| Field | Type |
|---|---|
expiration_time |
string (date-time) |
Generate new service provider API secret code
Generates a new API secret code for a service provider, invalidating the old one. Requires service provider owner permission.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
service_provider_api_secret_code_generate
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
api_secret_code |
string | API secret code for authenticating service provider requests |
Update a service provider
Updates an existing service provider profile.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
ServiceProviderRequest - API Source:
marketplace_service_providers_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
description |
string | |
enable_notifications |
boolean | |
customer |
string (uri) | ✓ |
image |
string (binary) |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
description |
string | |
enable_notifications |
boolean | |
customer |
string (uri) | |
customer_name |
string | |
customer_uuid |
string (uuid) | |
customer_image |
string (uri) | |
customer_abbreviation |
string | |
customer_slug |
string | |
customer_native_name |
string | |
customer_country |
string | |
image |
string (uri) | |
organization_groups |
array of objects | |
organization_groups.uuid |
string (uuid) | |
organization_groups.url |
string (uri) | |
organization_groups.name |
string | |
organization_groups.parent_uuid |
string (uuid) | UUID of the parent organization group |
organization_groups.parent_name |
string | Name of the parent organization group |
organization_groups.parent |
string (uri) | |
organization_groups.customers_count |
integer | Number of customers in this organization group |
offering_count |
integer |
Partially update a service provider
Partially updates an existing service provider profile.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedServiceProviderRequest - API Source:
marketplace_service_providers_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
description |
string | |
enable_notifications |
boolean | |
image |
string (binary) |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
description |
string | |
enable_notifications |
boolean | |
customer |
string (uri) | |
customer_name |
string | |
customer_uuid |
string (uuid) | |
customer_image |
string (uri) | |
customer_abbreviation |
string | |
customer_slug |
string | |
customer_native_name |
string | |
customer_country |
string | |
image |
string (uri) | |
organization_groups |
array of objects | |
organization_groups.uuid |
string (uuid) | |
organization_groups.url |
string (uri) | |
organization_groups.name |
string | |
organization_groups.parent_uuid |
string (uuid) | UUID of the parent organization group |
organization_groups.parent_name |
string | Name of the parent organization group |
organization_groups.parent |
string (uri) | |
organization_groups.customers_count |
integer | Number of customers in this organization group |
offering_count |
integer |
Delete a service provider
Deletes a service provider profile. Only possible if there are no active offerings.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_service_providers_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Resources and orders
Marketplace Orders
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/marketplace-orders/ |
List orders |
| GET | /api/marketplace-orders/{uuid}/ |
Retrieve an order |
| POST | /api/marketplace-orders/ |
Create an order |
| POST | /api/marketplace-orders/{uuid}/unlink/ |
Unlink an order (staff only) |
| DELETE | /api/marketplace-orders/{uuid}/ |
Delete a pending order |
| State Management | ||
| POST | /api/marketplace-orders/{uuid}/approve_by_consumer/ |
Approve an order (consumer) |
| POST | /api/marketplace-orders/{uuid}/approve_by_provider/ |
Approve an order (provider) |
| POST | /api/marketplace-orders/{uuid}/cancel/ |
Cancel an order |
| POST | /api/marketplace-orders/{uuid}/reject_by_consumer/ |
Reject an order (consumer) |
| POST | /api/marketplace-orders/{uuid}/reject_by_provider/ |
Reject an order (provider) |
| POST | /api/marketplace-orders/{uuid}/set_state_done/ |
Set order state to done (agent) |
| POST | /api/marketplace-orders/{uuid}/set_state_erred/ |
Set order state to erred (agent) |
| POST | /api/marketplace-orders/{uuid}/set_state_executing/ |
Set order state to executing (agent) |
| Configuration & Updates | ||
| POST | /api/marketplace-orders/{uuid}/delete_attachment/ |
Delete order attachment |
| POST | /api/marketplace-orders/{uuid}/set_backend_id/ |
Set order backend ID |
| POST | /api/marketplace-orders/{uuid}/update_attachment/ |
Update order attachment |
| Data & Reporting | ||
| GET | /api/marketplace-orders/{uuid}/offering/ |
Get offering details |
| Other Actions | ||
| POST | /api/marketplace-orders/{uuid}/set_consumer_info/ |
Set consumer info on order |
| POST | /api/marketplace-orders/{uuid}/set_provider_info/ |
Set provider info on order |
| PUT | /api/marketplace-orders/{uuid}/ |
Update |
| PATCH | /api/marketplace-orders/{uuid}/ |
Partial Update |
Core CRUD
List orders
Returns a paginated list of orders accessible to the current user. Orders are visible to service consumers (project/customer members with appropriate permissions) and service providers.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
- Model Source:
OrderDetailsFieldEnum - Model Source:
OrderDetailsOEnum - Model Source:
OrderState - Model Source:
RequestTypes - API Source:
marketplace_orders_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
can_approve_as_consumer |
boolean | Can approve as consumer |
can_approve_as_provider |
boolean | Can approve as provider |
category_uuid |
string (uuid) | Category UUID |
created |
string (date-time) | Created after |
customer_uuid |
string (uuid) | Customer UUID |
field |
array | |
modified |
string (date-time) | Modified after |
o |
array | Ordering |
offering |
string (uri) | |
offering_slug |
array | Multiple values may be separated by commas. |
offering_type |
array | Offering type |
offering_uuid |
string (uuid) | Offering UUID |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
parent_offering_uuid |
string (uuid) | |
project_uuid |
string (uuid) | Project UUID |
provider_uuid |
string (uuid) | Provider UUID |
query |
string | Search by order UUID, slug, project name or resource name |
resource |
string (uri) | Resource URL |
resource_name |
string | Resource name |
resource_uuid |
string (uuid) | Resource UUID |
service_manager_uuid |
string (uuid) | Service manager UUID |
state |
array | Order state |
type |
array | Order type |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
offering |
string (uri) | |
offering_name |
string | |
offering_uuid |
string (uuid) | |
offering_description |
string | |
offering_image |
string (uri) | |
offering_thumbnail |
string (uri) | |
offering_type |
string | |
offering_shared |
boolean | Accessible to all customers. |
offering_billable |
boolean | Purchase and usage is invoiced. |
offering_plugin_options |
any | Public data used by specific plugin, such as storage mode for OpenStack. |
provider_name |
string | |
provider_uuid |
string (uuid) | |
provider_slug |
string | |
category_title |
string | |
category_uuid |
string (uuid) | |
category_icon |
string (uri) | |
plan |
string (uri) | |
plan_unit |
any | |
plan_name |
string | |
plan_uuid |
string (uuid) | |
plan_description |
string | |
attributes |
any | |
limits |
object (free-form) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
modified |
string (date-time) | |
resource_uuid |
string (uuid) | |
resource_type |
string | |
resource_name |
string | |
cost |
string (decimal) | |
state |
any | |
output |
string | |
marketplace_resource_uuid |
string (uuid) | |
error_message |
string | |
error_traceback |
string | |
callback_url |
string (uri) | |
completed_at |
string (date-time) | |
request_comment |
string | |
attachment |
string (uri) | |
type |
any | |
start_date |
string (date) | Enables delayed processing of resource provisioning order. |
slug |
string | |
url |
string (uri) | |
consumer_reviewed_by |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
consumer_reviewed_by_full_name |
string | |
consumer_reviewed_by_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
consumer_reviewed_at |
string (date-time) | |
provider_reviewed_by |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
provider_reviewed_by_full_name |
string | |
provider_reviewed_by_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
provider_reviewed_at |
string (date-time) | |
created_by_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
created_by_full_name |
string | |
created_by_civil_number |
string | |
created_by_email |
string (email) | |
created_by_organization |
string | |
created_by_organization_registry_code |
string | Company registration code of the user's organization, if known |
customer_name |
string | |
customer_uuid |
string (uuid) | |
customer_slug |
string | |
project_name |
string | |
project_uuid |
string (uuid) | |
project_description |
string | |
project_slug |
string | |
old_plan_name |
string | |
new_plan_name |
string | |
old_plan_uuid |
string (uuid) | |
new_plan_uuid |
string (uuid) | |
old_cost_estimate |
number (double) | |
new_cost_estimate |
string (decimal) | |
can_terminate |
boolean | |
fixed_price |
number (double) | |
activation_price |
number (double) | |
termination_comment |
string | |
backend_id |
string | |
order_subtype |
string | |
provider_message |
string | |
provider_message_url |
string (uri) | |
provider_message_attachment |
string (uri) | |
consumer_message |
string | |
consumer_message_attachment |
string (uri) | |
consumer_rejection_comment |
string | |
provider_rejection_comment |
string | |
issue |
any |
Retrieve an order
Returns the details of a specific order.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
OrderDetailsFieldEnum - API Source:
marketplace_orders_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type | Description |
|---|---|---|
offering |
string (uri) | |
offering_name |
string | |
offering_uuid |
string (uuid) | |
offering_description |
string | |
offering_image |
string (uri) | |
offering_thumbnail |
string (uri) | |
offering_type |
string | |
offering_shared |
boolean | Accessible to all customers. |
offering_billable |
boolean | Purchase and usage is invoiced. |
offering_plugin_options |
any | Public data used by specific plugin, such as storage mode for OpenStack. |
provider_name |
string | |
provider_uuid |
string (uuid) | |
provider_slug |
string | |
category_title |
string | |
category_uuid |
string (uuid) | |
category_icon |
string (uri) | |
plan |
string (uri) | |
plan_unit |
any | |
plan_name |
string | |
plan_uuid |
string (uuid) | |
plan_description |
string | |
attributes |
any | |
limits |
object (free-form) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
modified |
string (date-time) | |
resource_uuid |
string (uuid) | |
resource_type |
string | |
resource_name |
string | |
cost |
string (decimal) | |
state |
any | |
output |
string | |
marketplace_resource_uuid |
string (uuid) | |
error_message |
string | |
error_traceback |
string | |
callback_url |
string (uri) | |
completed_at |
string (date-time) | |
request_comment |
string | |
attachment |
string (uri) | |
type |
any | |
start_date |
string (date) | Enables delayed processing of resource provisioning order. |
slug |
string | |
url |
string (uri) | |
consumer_reviewed_by |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
consumer_reviewed_by_full_name |
string | |
consumer_reviewed_by_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
consumer_reviewed_at |
string (date-time) | |
provider_reviewed_by |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
provider_reviewed_by_full_name |
string | |
provider_reviewed_by_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
provider_reviewed_at |
string (date-time) | |
created_by_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
created_by_full_name |
string | |
created_by_civil_number |
string | |
created_by_email |
string (email) | |
created_by_organization |
string | |
created_by_organization_registry_code |
string | Company registration code of the user's organization, if known |
customer_name |
string | |
customer_uuid |
string (uuid) | |
customer_slug |
string | |
project_name |
string | |
project_uuid |
string (uuid) | |
project_description |
string | |
project_slug |
string | |
old_plan_name |
string | |
new_plan_name |
string | |
old_plan_uuid |
string (uuid) | |
new_plan_uuid |
string (uuid) | |
old_cost_estimate |
number (double) | |
new_cost_estimate |
string (decimal) | |
can_terminate |
boolean | |
fixed_price |
number (double) | |
activation_price |
number (double) | |
termination_comment |
string | |
backend_id |
string | |
order_subtype |
string | |
provider_message |
string | |
provider_message_url |
string (uri) | |
provider_message_attachment |
string (uri) | |
consumer_message |
string | |
consumer_message_attachment |
string (uri) | |
consumer_rejection_comment |
string | |
provider_rejection_comment |
string | |
issue |
any |
Create an order
Creates a new order to provision a resource. The order will be placed in a pending state and may require approval depending on the offering and user permissions.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
OrderCreateRequest - API Source:
marketplace_orders_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Field | Type | Required | Description |
|---|---|---|---|
offering |
string (uri) | ✓ | |
plan |
string (uri) | ||
attributes |
any | Attributes structure depends on the offering type specified in the parent object. Can also be a generic object for offerings without a specific attributes schema. | |
limits |
object (free-form) | ||
accepting_terms_of_service |
boolean | Constraints: write-only |
|
callback_url |
string (uri) | ||
request_comment |
string | ||
type |
any | Constraints: default: Create |
|
start_date |
string (date) | Enables delayed processing of resource provisioning order. | |
slug |
string | URL-friendly identifier. Only editable by staff users. | |
project |
string (uri) | ✓ |
201 -
| Field | Type | Description |
|---|---|---|
offering |
string (uri) | |
offering_name |
string | |
offering_uuid |
string (uuid) | |
offering_description |
string | |
offering_image |
string (uri) | |
offering_thumbnail |
string (uri) | |
offering_type |
string | |
offering_shared |
boolean | Accessible to all customers. |
offering_billable |
boolean | Purchase and usage is invoiced. |
offering_plugin_options |
any | Public data used by specific plugin, such as storage mode for OpenStack. |
provider_name |
string | |
provider_uuid |
string (uuid) | |
provider_slug |
string | |
category_title |
string | |
category_uuid |
string (uuid) | |
category_icon |
string (uri) | |
plan |
string (uri) | |
plan_unit |
any | |
plan_name |
string | |
plan_uuid |
string (uuid) | |
plan_description |
string | |
attributes |
any | |
limits |
object (free-form) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
modified |
string (date-time) | |
resource_uuid |
string (uuid) | |
resource_type |
string | |
resource_name |
string | |
cost |
string (decimal) | |
state |
any | |
output |
string | |
marketplace_resource_uuid |
string (uuid) | |
error_message |
string | |
error_traceback |
string | |
callback_url |
string (uri) | |
completed_at |
string (date-time) | |
request_comment |
string | |
attachment |
string (uri) | |
type |
any | |
start_date |
string (date) | Enables delayed processing of resource provisioning order. |
slug |
string | |
url |
string (uri) | |
consumer_reviewed_by |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
consumer_reviewed_by_full_name |
string | |
consumer_reviewed_by_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
consumer_reviewed_at |
string (date-time) | |
provider_reviewed_by |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
provider_reviewed_by_full_name |
string | |
provider_reviewed_by_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
provider_reviewed_at |
string (date-time) | |
created_by_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
created_by_full_name |
string | |
created_by_civil_number |
string | |
created_by_email |
string (email) | |
created_by_organization |
string | |
created_by_organization_registry_code |
string | Company registration code of the user's organization, if known |
customer_name |
string | |
customer_uuid |
string (uuid) | |
customer_slug |
string | |
project_name |
string | |
project_uuid |
string (uuid) | |
project_description |
string | |
project_slug |
string | |
old_plan_name |
string | |
new_plan_name |
string | |
old_plan_uuid |
string (uuid) | |
new_plan_uuid |
string (uuid) | |
old_cost_estimate |
number (double) | |
new_cost_estimate |
string (decimal) | |
can_terminate |
boolean | |
fixed_price |
number (double) | |
activation_price |
number (double) | |
termination_comment |
string | |
backend_id |
string | |
order_subtype |
string | |
provider_message |
string | |
provider_message_url |
string (uri) | |
provider_message_attachment |
string (uri) | |
consumer_message |
string | |
consumer_message_attachment |
string (uri) | |
consumer_rejection_comment |
string | |
provider_rejection_comment |
string | |
issue |
any |
Unlink an order (staff only)
Forcefully deletes an order from the database without affecting the backend resource. This is a staff-only administrative action used to clean up stuck or invalid orders.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_orders_unlink
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
403 - No response body
Delete a pending order
Deletes an order that is still in a pending state (e.g., pending-consumer or pending-provider). Executing or completed orders cannot be deleted.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_orders_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
State Management
Approve an order (consumer)
Approves a pending order from the consumer's side (e.g., project manager, customer owner). This transitions the order to the next state, which could be pending provider approval or executing.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_orders_approve_by_consumer
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
detail |
string |
Approve an order (provider)
Approves a pending order from the provider's side. This typically transitions the order to the executing state.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
OrderApproveByProviderRequest - API Source:
marketplace_orders_approve_by_provider
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
attributes |
any |
200 -
| Field | Type |
|---|---|
detail |
string |
Cancel an order
Cancels an order. This is typically only possible for certain offering types (e.g., basic support) and in specific states (pending or executing).
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_orders_cancel
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
202 - No response body
Reject an order (consumer)
Rejects a pending order from the consumer's side. This moves the order to the 'rejected' state.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
OrderErrorDetailsRequest - API Source:
marketplace_orders_reject_by_consumer
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
error_message |
string | |
error_traceback |
string | |
consumer_rejection_comment |
string |
200 - No response body
Reject an order (provider)
Rejects a pending order from the provider's side. This moves the order to the 'rejected' state.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
OrderProviderRejectionRequest - API Source:
marketplace_orders_reject_by_provider
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
provider_rejection_comment |
string |
200 - No response body
Set order state to done (agent)
Used by external agents (e.g., site agent) to manually transition the order state to 'done'. This is only applicable for specific offering types.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_orders_set_state_done
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - No response body
Set order state to erred (agent)
Used by external agents to report a failure during order processing. An error message and traceback can be provided.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
OrderErrorDetailsRequest - API Source:
marketplace_orders_set_state_erred
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
error_message |
string | |
error_traceback |
string | |
consumer_rejection_comment |
string |
200 - No response body
Set order state to executing (agent)
Used by external agents (e.g., site agent) to manually transition the order state to 'executing'. This is only applicable for specific offering types.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_orders_set_state_executing
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - No response body
Configuration & Updates
Delete order attachment
Allows deleting an attachment from a pending order.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_orders_delete_attachment
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Set order backend ID
Allows a service provider or staff to set or update the backend ID associated with an order. This is useful for linking the order to an external system's identifier.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
OrderBackendIDRequest - API Source:
marketplace_orders_set_backend_id
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
backend_id |
string | ✓ |
200 -
| Field | Type |
|---|---|
status |
string |
Update order attachment
Allows uploading or replacing a file attachment (e.g., a purchase order) for a pending order.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
OrderAttachmentRequest - API Source:
marketplace_orders_update_attachment
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
attachment |
string (binary) |
200 -
| Field | Type |
|---|---|
attachment |
string (uri) |
Data & Reporting
Get offering details
Returns details of the offering connected to the requested object.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_orders_offering_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
name |
string | |
slug |
string | URL-friendly identifier. Only editable by staff users. |
description |
string | |
full_description |
string | |
privacy_policy_link |
string (uri) | |
access_url |
string (uri) | Publicly accessible offering access URL |
endpoints |
array of objects | |
endpoints.uuid |
string (uuid) | |
endpoints.name |
string | |
endpoints.url |
string | URL of the access endpoint |
software_catalogs |
array of objects | |
software_catalogs.uuid |
string (uuid) | |
software_catalogs.catalog |
any | |
software_catalogs.enabled_cpu_family |
any | List of enabled CPU families: ['x86_64', 'aarch64'] |
software_catalogs.enabled_cpu_microarchitectures |
any | List of enabled CPU microarchitectures: ['generic', 'zen3'] |
software_catalogs.package_count |
integer | |
software_catalogs.partition |
any | |
partitions |
array of objects | |
partitions.uuid |
string (uuid) | |
partitions.partition_name |
string | Name of the SLURM partition |
partitions.cpu_bind |
integer | Default task binding policy (SLURM cpu_bind) |
partitions.def_cpu_per_gpu |
integer | Default CPUs allocated per GPU |
partitions.max_cpus_per_node |
integer | Maximum allocated CPUs per node |
partitions.max_cpus_per_socket |
integer | Maximum allocated CPUs per socket |
partitions.def_mem_per_cpu |
integer (int64) | Default memory per CPU in MB |
partitions.def_mem_per_gpu |
integer (int64) | Default memory per GPU in MB |
partitions.def_mem_per_node |
integer (int64) | Default memory per node in MB |
partitions.max_mem_per_cpu |
integer (int64) | Maximum memory per CPU in MB |
partitions.max_mem_per_node |
integer (int64) | Maximum memory per node in MB |
partitions.default_time |
integer | Default time limit in minutes |
partitions.max_time |
integer | Maximum time limit in minutes |
partitions.grace_time |
integer | Preemption grace time in seconds |
partitions.max_nodes |
integer | Maximum nodes per job |
partitions.min_nodes |
integer | Minimum nodes per job |
partitions.exclusive_topo |
boolean | Exclusive topology access required |
partitions.exclusive_user |
boolean | Exclusive user access required |
partitions.priority_tier |
integer | Priority tier for scheduling and preemption |
partitions.qos |
string | Quality of Service (QOS) name |
partitions.req_resv |
boolean | Require reservation for job allocation |
roles |
array of objects | |
roles.uuid |
string (uuid) | |
roles.name |
string | |
roles.url |
string (uri) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
project |
string (uri) | |
project_uuid |
string (uuid) | |
project_name |
string | |
category |
string (uri) | |
category_uuid |
string (uuid) | |
category_title |
string | |
attributes |
object (free-form) | |
options |
any | |
resource_options |
any | |
components |
array of objects | |
components.uuid |
string (uuid) | |
components.billing_type |
string | Enum: fixed, usage, limit, one, few |
components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
components.name |
string | Display name for the measured unit, for example, Floating IP. |
components.description |
string | |
components.measured_unit |
string | Unit of measurement, for example, GB. |
components.unit_factor |
integer | The conversion factor from backend units to measured_unit |
components.limit_period |
any | |
components.limit_amount |
integer | |
components.article_code |
string | |
components.max_value |
integer | |
components.min_value |
integer | |
components.max_available_limit |
integer | |
components.is_boolean |
boolean | |
components.default_limit |
integer | |
components.factor |
integer | |
components.is_builtin |
boolean | |
components.is_prepaid |
boolean | |
components.overage_component |
string (uuid) | |
components.min_prepaid_duration |
integer | |
components.max_prepaid_duration |
integer | |
plugin_options |
any | |
state |
any | |
vendor_details |
string | |
getting_started |
string | |
integration_guide |
string | |
thumbnail |
string (uri) | |
order_count |
integer | |
plans |
array of objects | |
plans.url |
string (uri) | |
plans.uuid |
string (uuid) | |
plans.name |
string | |
plans.description |
string | |
plans.article_code |
string | |
plans.max_amount |
integer | Maximum number of plans that could be active. Plan is disabled when maximum amount is reached. |
plans.archived |
boolean | Forbids creation of new resources. |
plans.is_active |
boolean | |
plans.unit_price |
string (decimal) | |
plans.unit |
string | Enum: month, quarter, half_month, day, hour, quantity |
plans.init_price |
number (double) | |
plans.switch_price |
number (double) | |
plans.backend_id |
string | |
plans.organization_groups |
array of objects | |
plans.organization_groups.uuid |
string (uuid) | |
plans.organization_groups.url |
string (uri) | |
plans.organization_groups.name |
string | |
plans.organization_groups.parent_uuid |
string (uuid) | UUID of the parent organization group |
plans.organization_groups.parent_name |
string | Name of the parent organization group |
plans.organization_groups.parent |
string (uri) | |
plans.organization_groups.customers_count |
integer | Number of customers in this organization group |
plans.components |
array of objects | |
plans.components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
plans.components.name |
string | Display name for the measured unit, for example, Floating IP. |
plans.components.measured_unit |
string | Unit of measurement, for example, GB. |
plans.components.amount |
integer | |
plans.components.price |
string (decimal) | |
plans.components.future_price |
string (decimal) | |
plans.components.discount_threshold |
integer | Minimum amount to be eligible for discount. |
plans.components.discount_rate |
integer | Discount rate in percentage. |
plans.prices |
object (free-form) | |
plans.future_prices |
object (free-form) | |
plans.quotas |
object (free-form) | |
plans.resources_count |
integer | |
plans.plan_type |
string | |
plans.minimal_price |
number (double) | |
screenshots |
array of objects | |
screenshots.name |
string | |
screenshots.uuid |
string (uuid) | |
screenshots.description |
string | |
screenshots.image |
string (uri) | |
screenshots.thumbnail |
string (uri) | |
screenshots.created |
string (date-time) | |
type |
string | |
shared |
boolean | Accessible to all customers. |
billable |
boolean | Purchase and usage is invoiced. |
scope |
string | |
scope_uuid |
string (uuid) | |
scope_name |
string (uuid) | |
scope_state |
any | |
scope_error_message |
string | |
files |
array of objects | |
files.name |
string | |
files.created |
string (date-time) | |
files.file |
string (uri) | |
quotas |
array of objects | |
quotas.name |
string | |
quotas.usage |
integer | |
quotas.limit |
integer | |
paused_reason |
string | |
datacite_doi |
string | |
citation_count |
integer | Number of citations of a DOI |
latitude |
number (double) | |
longitude |
number (double) | |
country |
any | Country code (ISO 3166-1 alpha-2) |
backend_id |
string | |
organization_groups |
array of objects | |
organization_groups.uuid |
string (uuid) | |
organization_groups.url |
string (uri) | |
organization_groups.name |
string | |
organization_groups.parent_uuid |
string (uuid) | UUID of the parent organization group |
organization_groups.parent_name |
string | Name of the parent organization group |
organization_groups.parent |
string (uri) | |
organization_groups.customers_count |
integer | Number of customers in this organization group |
tags |
array of objects | |
tags.uuid |
string (uuid) | |
tags.name |
string | |
image |
string (uri) | |
total_customers |
integer | |
total_cost |
integer | |
total_cost_estimated |
integer | |
parent_description |
string | |
parent_uuid |
string (uuid) | |
parent_name |
string | |
backend_metadata |
any | |
has_compliance_requirements |
boolean | |
billing_type_classification |
string | Classify offering components by billing type. Returns 'limit_only', 'usage_only', or 'mixed'. |
compliance_checklist |
string (uri) | |
user_has_consent |
boolean | |
is_accessible |
boolean | |
google_calendar_is_public |
boolean | |
google_calendar_link |
string | Get the Google Calendar link for an offering. |
promotion_campaigns |
array of objects | |
promotion_campaigns.uuid |
string (uuid) | |
promotion_campaigns.name |
string | |
promotion_campaigns.start_date |
string (date) | Starting from this date, the campaign is active. |
promotion_campaigns.end_date |
string (date) | The last day the campaign is active. |
promotion_campaigns.discount_type |
string | Enum: discount, special_price |
promotion_campaigns.discount |
integer | |
promotion_campaigns.stock |
integer | |
promotion_campaigns.description |
string | |
promotion_campaigns.months |
integer | How many months in a row should the related service (when activated) get special deal (0 for indefinitely until active) |
promotion_campaigns.service_provider |
string (uri) |
Other Actions
Set consumer info on order
Allows a consumer to respond to a provider's message with an optional message and file attachment on a pending order.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
OrderConsumerInfoRequest - API Source:
marketplace_orders_set_consumer_info
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
consumer_message |
string | |
consumer_message_attachment |
string (binary) |
200 -
| Field | Type |
|---|---|
detail |
string |
Set provider info on order
Allows a service provider to send a message with an optional URL and file attachment to the consumer on a pending order.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
OrderProviderInfoRequest - API Source:
marketplace_orders_set_provider_info
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
provider_message |
string | |
provider_message_url |
string (uri) | |
provider_message_attachment |
string (binary) |
200 -
| Field | Type |
|---|---|
detail |
string |
Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
OrderUpdateRequest - API Source:
marketplace_orders_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
limits |
object (free-form) | ||
attributes |
any | ||
start_date |
string (date) | Enables delayed processing of resource provisioning order. |
200 -
| Field | Type | Description |
|---|---|---|
limits |
object (free-form) | |
attributes |
any | |
start_date |
string (date) | Enables delayed processing of resource provisioning order. |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedOrderUpdateRequest - API Source:
marketplace_orders_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
limits |
object (free-form) | ||
attributes |
any | ||
start_date |
string (date) | Enables delayed processing of resource provisioning order. |
200 -
| Field | Type | Description |
|---|---|---|
limits |
object (free-form) | |
attributes |
any | |
start_date |
string (date) | Enables delayed processing of resource provisioning order. |
Marketplace Resources
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/marketplace-resources/ |
List consumer resources |
| GET | /api/marketplace-resources/{uuid}/ |
Retrieve a consumer resource |
| POST | /api/marketplace-resources/{uuid}/pull/ |
Pull resource data |
| POST | /api/marketplace-resources/{uuid}/unlink/ |
Unlink a resource (staff only) |
| PUT | /api/marketplace-resources/{uuid}/ |
Update a consumer resource |
| PATCH | /api/marketplace-resources/{uuid}/ |
Partially update a consumer resource |
| State Management | ||
| POST | /api/marketplace-resources/{uuid}/set_downscaled/ |
Set downscaled flag for resource |
| POST | /api/marketplace-resources/{uuid}/set_paused/ |
Set paused flag for resource |
| POST | /api/marketplace-resources/{uuid}/terminate/ |
Terminate a resource |
| Configuration & Updates | ||
| POST | /api/marketplace-resources/{uuid}/move_resource/ |
Move a resource to another project |
| POST | /api/marketplace-resources/{uuid}/renew/ |
Renew a prepaid resource |
| POST | /api/marketplace-resources/{uuid}/set_end_date_by_staff/ |
Set end date of the resource by staff |
| POST | /api/marketplace-resources/{uuid}/set_restrict_member_access/ |
Set restrict member access flag |
| POST | /api/marketplace-resources/{uuid}/set_slug/ |
Set resource slug |
| POST | /api/marketplace-resources/{uuid}/switch_plan/ |
Switch resource plan |
| POST | /api/marketplace-resources/{uuid}/update_limits/ |
Update resource limits |
| POST | /api/marketplace-resources/{uuid}/update_options/ |
Update resource options |
| Data & Reporting | ||
| GET | /api/marketplace-resources/{uuid}/details/ |
Get resource details |
| GET | /api/marketplace-resources/{uuid}/glauth_users_config/ |
Get GLauth user configuration for a resource |
| GET | /api/marketplace-resources/{uuid}/offering_for_subresources/ |
List offerings for sub-resources |
| GET | /api/marketplace-resources/{uuid}/offering/ |
Get offering details |
| GET | /api/marketplace-resources/{uuid}/plan_periods/ |
List resource plan periods |
| GET | /api/marketplace-resources/{uuid}/team/ |
Get resource team |
| Naming | ||
| POST | /api/marketplace-resources/suggest_name/ |
Suggest a resource name |
| Other Actions | ||
| GET | /api/marketplace-resources/{uuid}/history/at/ |
Get object state at a specific timestamp |
| GET | /api/marketplace-resources/{uuid}/history/ |
Get version history |
| POST | /api/marketplace-resources/{uuid}/estimate_renewal/ |
Estimate renewal cost breakdown |
| POST | /api/marketplace-resources/{uuid}/reallocate_limits/ |
Reallocate resource limits |
| POST | /api/marketplace-resources/{uuid}/restore/ |
Restore |
Core CRUD
List consumer resources
Returns a paginated list of resources accessible to the current user as a service consumer.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
- Model Source:
OrderState - Model Source:
ResourceFieldEnum - Model Source:
ResourceOEnum - Model Source:
ResourceState - API Source:
marketplace_resources_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
backend_id |
string | Backend ID |
category_uuid |
string (uuid) | Category UUID |
component_count |
number | Filter by exact number of components |
created |
string (date-time) | Created after |
customer |
string (uri) | Customer URL |
customer_uuid |
string (uuid) | Customer UUID |
downscaled |
boolean | Downscaled |
field |
array | |
has_terminate_date |
boolean | Has termination date |
is_attached |
boolean | Filter by attached state |
lexis_links_supported |
boolean | LEXIS links supported |
limit_based |
boolean | Filter by limit-based offerings |
limit_component_count |
number | Filter by exact number of limit-based components |
modified |
string (date-time) | Modified after |
name |
string | Name |
name_exact |
string | Name (exact) |
o |
array | Ordering |
offering |
string (uri) | |
offering_billable |
boolean | Offering billable |
offering_shared |
boolean | Offering shared |
offering_slug |
array | Multiple values may be separated by commas. |
offering_type |
string | Offering type |
offering_uuid |
array | Multiple values may be separated by commas. |
only_limit_based |
boolean | Filter resources with only limit-based components |
only_usage_based |
boolean | Filter resources with only usage-based components |
order_state |
array | Order state |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
parent_offering_uuid |
string (uuid) | |
paused |
boolean | Paused |
plan_uuid |
string (uuid) | Plan UUID |
project_name |
string | Project name |
project_uuid |
string (uuid) | Project UUID |
provider_uuid |
string (uuid) | Provider UUID |
query |
string | Search by resource UUID, name, slug, backend ID, effective ID, IPs or hypervisor |
restrict_member_access |
boolean | Restrict member access |
runtime_state |
string | Runtime state |
scope |
string (uri) | Filter by scope URL. |
service_manager_uuid |
string (uuid) | Service manager UUID |
state |
array | Resource state |
usage_based |
boolean | Filter by usage-based offerings |
visible_to_providers |
boolean | Include only resources visible to service providers |
visible_to_username |
string | Visible to username |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
offering |
string (uri) | |
offering_name |
string | |
offering_uuid |
string (uuid) | |
offering_description |
string | |
offering_image |
string (uri) | |
offering_thumbnail |
string (uri) | |
offering_type |
string | |
offering_shared |
boolean | Accessible to all customers. |
offering_billable |
boolean | Purchase and usage is invoiced. |
offering_plugin_options |
any | Public data used by specific plugin, such as storage mode for OpenStack. |
provider_name |
string | |
provider_uuid |
string (uuid) | |
provider_slug |
string | |
category_title |
string | |
category_uuid |
string (uuid) | |
category_icon |
string (uri) | |
plan |
string (uri) | |
plan_unit |
any | |
plan_name |
string | |
plan_uuid |
string (uuid) | |
plan_description |
string | |
attributes |
object (free-form) | |
limits |
object (free-form) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
modified |
string (date-time) | |
url |
string (uri) | |
scope |
string | |
description |
string | |
state |
any | |
resource_uuid |
string (uuid) | |
backend_id |
string | |
effective_id |
string | |
resource_type |
string | |
project |
string (uri) | |
project_uuid |
string (uuid) | |
project_name |
string | |
project_description |
string | |
project_end_date |
string (date) | The date is inclusive. Once reached, all project resource will be scheduled for termination. |
project_end_date_requested_by |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
offering_slug |
string | |
parent_offering_uuid |
string (uuid) | |
parent_offering_name |
string | |
parent_offering_slug |
string | |
offering_backend_id |
string | |
parent_uuid |
string (uuid) | |
parent_name |
string | |
backend_metadata |
any | |
is_usage_based |
boolean | Returns True if the resource has usage-based components that track variable consumption. |
is_limit_based |
boolean | Returns True if the resource has limit-based components with user-adjustable quotas. |
name |
string | |
slug |
string | URL-friendly identifier. Only editable by staff users. |
current_usages |
object (free-form) | Dictionary mapping component types to their latest reported usage amounts. |
can_terminate |
boolean | |
report |
array of objects | |
report.header |
string | Section header text |
report.body |
string | Section body content |
end_date |
string (date) | The date is inclusive. Once reached, a resource will be scheduled for termination. |
end_date_requested_by |
string (uri) | |
username |
string | |
limit_usage |
object (free-form) | Dictionary mapping limit-based component types to their consumed usage. For monthly periods, maps from current_usages; for longer periods, aggregates historical usage. |
downscaled |
boolean | |
restrict_member_access |
boolean | |
paused |
boolean | |
endpoints |
array of objects | |
endpoints.uuid |
string (uuid) | |
endpoints.name |
string | |
endpoints.url |
string | URL of the access endpoint |
error_message |
string | |
error_traceback |
string | |
options |
any | |
available_actions |
array of strings | |
last_sync |
string (date-time) | |
order_in_progress |
any | |
creation_order |
any | |
service_settings_uuid |
string (uuid) | |
project_slug |
string | |
customer_slug |
string | |
user_requires_reconsent |
boolean | Check if the current user needs to re-consent for this resource's offering. |
renewal_date |
object (free-form) | |
offering_state |
any | |
offering_components |
array of objects | |
offering_components.uuid |
string (uuid) | |
offering_components.billing_type |
string | Enum: fixed, usage, limit, one, few |
offering_components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
offering_components.name |
string | Display name for the measured unit, for example, Floating IP. |
offering_components.description |
string | |
offering_components.measured_unit |
string | Unit of measurement, for example, GB. |
offering_components.unit_factor |
integer | The conversion factor from backend units to measured_unit |
offering_components.limit_period |
any | |
offering_components.limit_amount |
integer | |
offering_components.article_code |
string | |
offering_components.max_value |
integer | |
offering_components.min_value |
integer | |
offering_components.max_available_limit |
integer | |
offering_components.is_boolean |
boolean | |
offering_components.default_limit |
integer | |
offering_components.factor |
integer | |
offering_components.is_builtin |
boolean | |
offering_components.is_prepaid |
boolean | |
offering_components.overage_component |
string (uuid) | |
offering_components.min_prepaid_duration |
integer | |
offering_components.max_prepaid_duration |
integer |
Retrieve a consumer resource
Returns details of a specific resource accessible to the consumer.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
ResourceFieldEnum - API Source:
marketplace_resources_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type | Description |
|---|---|---|
offering |
string (uri) | |
offering_name |
string | |
offering_uuid |
string (uuid) | |
offering_description |
string | |
offering_image |
string (uri) | |
offering_thumbnail |
string (uri) | |
offering_type |
string | |
offering_shared |
boolean | Accessible to all customers. |
offering_billable |
boolean | Purchase and usage is invoiced. |
offering_plugin_options |
any | Public data used by specific plugin, such as storage mode for OpenStack. |
provider_name |
string | |
provider_uuid |
string (uuid) | |
provider_slug |
string | |
category_title |
string | |
category_uuid |
string (uuid) | |
category_icon |
string (uri) | |
plan |
string (uri) | |
plan_unit |
any | |
plan_name |
string | |
plan_uuid |
string (uuid) | |
plan_description |
string | |
attributes |
object (free-form) | |
limits |
object (free-form) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
modified |
string (date-time) | |
url |
string (uri) | |
scope |
string | |
description |
string | |
state |
any | |
resource_uuid |
string (uuid) | |
backend_id |
string | |
effective_id |
string | |
resource_type |
string | |
project |
string (uri) | |
project_uuid |
string (uuid) | |
project_name |
string | |
project_description |
string | |
project_end_date |
string (date) | The date is inclusive. Once reached, all project resource will be scheduled for termination. |
project_end_date_requested_by |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
offering_slug |
string | |
parent_offering_uuid |
string (uuid) | |
parent_offering_name |
string | |
parent_offering_slug |
string | |
offering_backend_id |
string | |
parent_uuid |
string (uuid) | |
parent_name |
string | |
backend_metadata |
any | |
is_usage_based |
boolean | Returns True if the resource has usage-based components that track variable consumption. |
is_limit_based |
boolean | Returns True if the resource has limit-based components with user-adjustable quotas. |
name |
string | |
slug |
string | URL-friendly identifier. Only editable by staff users. |
current_usages |
object (free-form) | Dictionary mapping component types to their latest reported usage amounts. |
can_terminate |
boolean | |
report |
array of objects | |
report.header |
string | Section header text |
report.body |
string | Section body content |
end_date |
string (date) | The date is inclusive. Once reached, a resource will be scheduled for termination. |
end_date_requested_by |
string (uri) | |
username |
string | |
limit_usage |
object (free-form) | Dictionary mapping limit-based component types to their consumed usage. For monthly periods, maps from current_usages; for longer periods, aggregates historical usage. |
downscaled |
boolean | |
restrict_member_access |
boolean | |
paused |
boolean | |
endpoints |
array of objects | |
endpoints.uuid |
string (uuid) | |
endpoints.name |
string | |
endpoints.url |
string | URL of the access endpoint |
error_message |
string | |
error_traceback |
string | |
options |
any | |
available_actions |
array of strings | |
last_sync |
string (date-time) | |
order_in_progress |
any | |
creation_order |
any | |
service_settings_uuid |
string (uuid) | |
project_slug |
string | |
customer_slug |
string | |
user_requires_reconsent |
boolean | Check if the current user needs to re-consent for this resource's offering. |
renewal_date |
object (free-form) | |
offering_state |
any | |
offering_components |
array of objects | |
offering_components.uuid |
string (uuid) | |
offering_components.billing_type |
string | Enum: fixed, usage, limit, one, few |
offering_components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
offering_components.name |
string | Display name for the measured unit, for example, Floating IP. |
offering_components.description |
string | |
offering_components.measured_unit |
string | Unit of measurement, for example, GB. |
offering_components.unit_factor |
integer | The conversion factor from backend units to measured_unit |
offering_components.limit_period |
any | |
offering_components.limit_amount |
integer | |
offering_components.article_code |
string | |
offering_components.max_value |
integer | |
offering_components.min_value |
integer | |
offering_components.max_available_limit |
integer | |
offering_components.is_boolean |
boolean | |
offering_components.default_limit |
integer | |
offering_components.factor |
integer | |
offering_components.is_builtin |
boolean | |
offering_components.is_prepaid |
boolean | |
offering_components.overage_component |
string (uuid) | |
offering_components.min_prepaid_duration |
integer | |
offering_components.max_prepaid_duration |
integer |
Pull resource data
Schedules a task to pull the latest data for the resource from its backend.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_resources_pull
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
202 -
| Field | Type |
|---|---|
detail |
string |
Unlink a resource (staff only)
Forcefully deletes a marketplace resource and its related plugin resource from the database. This action does not schedule operations on the backend and is intended for cleaning up resources stuck in transitioning states. Requires staff permissions.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_resources_unlink
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
403 - No response body
Update a consumer resource
Updates the name, description, or end date of a resource.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
ResourceUpdateRequest - API Source:
marketplace_resources_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ✓ | |
description |
string | ||
end_date |
string (date) | The date is inclusive. Once reached, a resource will be scheduled for termination. |
200 -
| Field | Type | Description |
|---|---|---|
name |
string | |
description |
string | |
end_date |
string (date) | The date is inclusive. Once reached, a resource will be scheduled for termination. |
Partially update a consumer resource
Partially updates the name, description, or end date of a resource.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedResourceUpdateRequest - API Source:
marketplace_resources_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ||
description |
string | ||
end_date |
string (date) | The date is inclusive. Once reached, a resource will be scheduled for termination. |
200 -
| Field | Type | Description |
|---|---|---|
name |
string | |
description |
string | |
end_date |
string (date) | The date is inclusive. Once reached, a resource will be scheduled for termination. |
State Management
Set downscaled flag for resource
Sets the 'downscaled' flag for a resource. Requires staff permissions.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
ResourceDownscaledRequest - API Source:
marketplace_resources_set_downscaled
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
downscaled |
boolean |
200 -
| Field | Type |
|---|---|
status |
string |
Set paused flag for resource
Sets the 'paused' flag for a resource. Requires staff permissions.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
ResourcePausedRequest - API Source:
marketplace_resources_set_paused
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
paused |
boolean |
200 -
| Field | Type |
|---|---|
status |
string |
Terminate a resource
Creates a marketplace order to terminate the resource. This action is asynchronous and may require approval.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
ResourceTerminateRequest - API Source:
marketplace_resources_terminate
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
attributes |
any | Optional attributes/parameters to pass to the termination operation |
200 -
| Field | Type | Description |
|---|---|---|
order_uuid |
string (uuid) | UUID of the created or updated order |
Configuration & Updates
Move a resource to another project
Moves a resource and its associated data to a different project. Requires staff permissions.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
MoveResourceRequest - API Source:
marketplace_resources_move_resource
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
project |
any | ✓ | Target project URL where the resource should be moved Constraints: write-only |
200 -
| Field | Type | Description |
|---|---|---|
offering |
string (uri) | |
offering_name |
string | |
offering_uuid |
string (uuid) | |
offering_description |
string | |
offering_image |
string (uri) | |
offering_thumbnail |
string (uri) | |
offering_type |
string | |
offering_shared |
boolean | Accessible to all customers. |
offering_billable |
boolean | Purchase and usage is invoiced. |
offering_plugin_options |
any | Public data used by specific plugin, such as storage mode for OpenStack. |
provider_name |
string | |
provider_uuid |
string (uuid) | |
provider_slug |
string | |
category_title |
string | |
category_uuid |
string (uuid) | |
category_icon |
string (uri) | |
plan |
string (uri) | |
plan_unit |
any | |
plan_name |
string | |
plan_uuid |
string (uuid) | |
plan_description |
string | |
attributes |
object (free-form) | |
limits |
object (free-form) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
modified |
string (date-time) | |
url |
string (uri) | |
scope |
string | |
description |
string | |
state |
any | |
resource_uuid |
string (uuid) | |
backend_id |
string | |
effective_id |
string | |
resource_type |
string | |
project |
string (uri) | |
project_uuid |
string (uuid) | |
project_name |
string | |
project_description |
string | |
project_end_date |
string (date) | The date is inclusive. Once reached, all project resource will be scheduled for termination. |
project_end_date_requested_by |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
offering_slug |
string | |
parent_offering_uuid |
string (uuid) | |
parent_offering_name |
string | |
parent_offering_slug |
string | |
offering_backend_id |
string | |
parent_uuid |
string (uuid) | |
parent_name |
string | |
backend_metadata |
any | |
is_usage_based |
boolean | Returns True if the resource has usage-based components that track variable consumption. |
is_limit_based |
boolean | Returns True if the resource has limit-based components with user-adjustable quotas. |
name |
string | |
slug |
string | URL-friendly identifier. Only editable by staff users. |
current_usages |
object (free-form) | Dictionary mapping component types to their latest reported usage amounts. |
can_terminate |
boolean | |
report |
array of objects | |
report.header |
string | Section header text |
report.body |
string | Section body content |
end_date |
string (date) | The date is inclusive. Once reached, a resource will be scheduled for termination. |
end_date_requested_by |
string (uri) | |
username |
string | |
limit_usage |
object (free-form) | Dictionary mapping limit-based component types to their consumed usage. For monthly periods, maps from current_usages; for longer periods, aggregates historical usage. |
downscaled |
boolean | |
restrict_member_access |
boolean | |
paused |
boolean | |
endpoints |
array of objects | |
endpoints.uuid |
string (uuid) | |
endpoints.name |
string | |
endpoints.url |
string | URL of the access endpoint |
error_message |
string | |
error_traceback |
string | |
options |
any | |
available_actions |
array of strings | |
last_sync |
string (date-time) | |
order_in_progress |
any | |
creation_order |
any | |
service_settings_uuid |
string (uuid) | |
project_slug |
string | |
customer_slug |
string | |
user_requires_reconsent |
boolean | Check if the current user needs to re-consent for this resource's offering. |
renewal_date |
object (free-form) | |
offering_state |
any | |
offering_components |
array of objects | |
offering_components.uuid |
string (uuid) | |
offering_components.billing_type |
string | Enum: fixed, usage, limit, one, few |
offering_components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
offering_components.name |
string | Display name for the measured unit, for example, Floating IP. |
offering_components.description |
string | |
offering_components.measured_unit |
string | Unit of measurement, for example, GB. |
offering_components.unit_factor |
integer | The conversion factor from backend units to measured_unit |
offering_components.limit_period |
any | |
offering_components.limit_amount |
integer | |
offering_components.article_code |
string | |
offering_components.max_value |
integer | |
offering_components.min_value |
integer | |
offering_components.max_available_limit |
integer | |
offering_components.is_boolean |
boolean | |
offering_components.default_limit |
integer | |
offering_components.factor |
integer | |
offering_components.is_builtin |
boolean | |
offering_components.is_prepaid |
boolean | |
offering_components.overage_component |
string (uuid) | |
offering_components.min_prepaid_duration |
integer | |
offering_components.max_prepaid_duration |
integer |
Renew a prepaid resource
Creates a renewal order to extend the subscription period of a prepaid resource. Optionally, limits can be upgraded at the same time.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
ResourceRenewRequest - API Source:
marketplace_resources_renew
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
extension_months |
integer | ✓ | Number of months to extend the subscription by. |
limits |
object (free-form) | Optional new limits for the resource. Supports upgrades only. | |
request_comment |
string | Optional comment for the renewal request. | |
attachment |
string (binary) | Optional PDF attachment for the renewal request. |
200 -
| Field | Type | Description |
|---|---|---|
order_uuid |
string (uuid) | UUID of the created or updated order |
Set end date of the resource by staff
Allows a staff user to set or update the end date for a resource, which will schedule it for termination.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
ResourceEndDateByProviderRequest - API Source:
marketplace_resources_set_end_date_by_staff
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
end_date |
string (date) | The date is inclusive. Once reached, a resource will be scheduled for termination. |
200 - No response body
Set restrict member access flag
Sets the 'restrict_member_access' flag for a resource. Requires staff permissions.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
ResourceRestrictMemberAccessRequest - API Source:
marketplace_resources_set_restrict_member_access
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
restrict_member_access |
boolean |
200 -
| Field | Type |
|---|---|
status |
string |
Set resource slug
Updates the slug for a resource. Requires staff permissions.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
ResourceSlugRequest - API Source:
marketplace_resources_set_slug
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
slug |
string | ✓ |
200 -
| Field | Type |
|---|---|
status |
string |
Switch resource plan
Creates a marketplace order to switch the billing plan for a resource. This action is asynchronous and may require approval.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
ResourceSwitchPlanRequest - API Source:
marketplace_resources_switch_plan
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
plan |
string (uri) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
order_uuid |
string (uuid) | UUID of the created or updated order |
Update resource limits
Creates a marketplace order to update the limits (e.g., CPU, RAM) for a resource. This action is asynchronous and may require approval.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
ResourceUpdateLimitsRequest - API Source:
marketplace_resources_update_limits
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
limits |
object (free-form) | ✓ |
request_comment |
string |
200 -
| Field | Type | Description |
|---|---|---|
order_uuid |
string (uuid) | UUID of the created or updated order |
Update resource options
Updates the options of a resource. If the offering is configured to create orders for option changes, a new UPDATE order will be created. Otherwise, the options are updated directly.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
ResourceOptionsRequest - API Source:
marketplace_resources_update_options
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
options |
any |
200 -
| Field | Type | Description |
|---|---|---|
status |
string | Status of the resource response |
201 -
| Field | Type | Description |
|---|---|---|
order_uuid |
string (uuid) | UUID of the created or updated order |
409 - No response body
Data & Reporting
Get resource details
Returns the detailed representation of the backend resource associated with the marketplace resource. The format of the response depends on the resource type.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_resources_details_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
204 -
404 -
Get GLauth user configuration for a resource
1 2 | |
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
List offerings for sub-resources
Returns a list of offerings that can be provisioned as sub-resources of the current resource.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | UUID of the offering |
type |
string | Type of the offering |
Get offering details
Returns details of the offering connected to the requested object.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_resources_offering_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
name |
string | |
slug |
string | URL-friendly identifier. Only editable by staff users. |
description |
string | |
full_description |
string | |
privacy_policy_link |
string (uri) | |
access_url |
string (uri) | Publicly accessible offering access URL |
endpoints |
array of objects | |
endpoints.uuid |
string (uuid) | |
endpoints.name |
string | |
endpoints.url |
string | URL of the access endpoint |
software_catalogs |
array of objects | |
software_catalogs.uuid |
string (uuid) | |
software_catalogs.catalog |
any | |
software_catalogs.enabled_cpu_family |
any | List of enabled CPU families: ['x86_64', 'aarch64'] |
software_catalogs.enabled_cpu_microarchitectures |
any | List of enabled CPU microarchitectures: ['generic', 'zen3'] |
software_catalogs.package_count |
integer | |
software_catalogs.partition |
any | |
partitions |
array of objects | |
partitions.uuid |
string (uuid) | |
partitions.partition_name |
string | Name of the SLURM partition |
partitions.cpu_bind |
integer | Default task binding policy (SLURM cpu_bind) |
partitions.def_cpu_per_gpu |
integer | Default CPUs allocated per GPU |
partitions.max_cpus_per_node |
integer | Maximum allocated CPUs per node |
partitions.max_cpus_per_socket |
integer | Maximum allocated CPUs per socket |
partitions.def_mem_per_cpu |
integer (int64) | Default memory per CPU in MB |
partitions.def_mem_per_gpu |
integer (int64) | Default memory per GPU in MB |
partitions.def_mem_per_node |
integer (int64) | Default memory per node in MB |
partitions.max_mem_per_cpu |
integer (int64) | Maximum memory per CPU in MB |
partitions.max_mem_per_node |
integer (int64) | Maximum memory per node in MB |
partitions.default_time |
integer | Default time limit in minutes |
partitions.max_time |
integer | Maximum time limit in minutes |
partitions.grace_time |
integer | Preemption grace time in seconds |
partitions.max_nodes |
integer | Maximum nodes per job |
partitions.min_nodes |
integer | Minimum nodes per job |
partitions.exclusive_topo |
boolean | Exclusive topology access required |
partitions.exclusive_user |
boolean | Exclusive user access required |
partitions.priority_tier |
integer | Priority tier for scheduling and preemption |
partitions.qos |
string | Quality of Service (QOS) name |
partitions.req_resv |
boolean | Require reservation for job allocation |
roles |
array of objects | |
roles.uuid |
string (uuid) | |
roles.name |
string | |
roles.url |
string (uri) | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
project |
string (uri) | |
project_uuid |
string (uuid) | |
project_name |
string | |
category |
string (uri) | |
category_uuid |
string (uuid) | |
category_title |
string | |
attributes |
object (free-form) | |
options |
any | |
resource_options |
any | |
components |
array of objects | |
components.uuid |
string (uuid) | |
components.billing_type |
string | Enum: fixed, usage, limit, one, few |
components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
components.name |
string | Display name for the measured unit, for example, Floating IP. |
components.description |
string | |
components.measured_unit |
string | Unit of measurement, for example, GB. |
components.unit_factor |
integer | The conversion factor from backend units to measured_unit |
components.limit_period |
any | |
components.limit_amount |
integer | |
components.article_code |
string | |
components.max_value |
integer | |
components.min_value |
integer | |
components.max_available_limit |
integer | |
components.is_boolean |
boolean | |
components.default_limit |
integer | |
components.factor |
integer | |
components.is_builtin |
boolean | |
components.is_prepaid |
boolean | |
components.overage_component |
string (uuid) | |
components.min_prepaid_duration |
integer | |
components.max_prepaid_duration |
integer | |
plugin_options |
any | |
state |
any | |
vendor_details |
string | |
getting_started |
string | |
integration_guide |
string | |
thumbnail |
string (uri) | |
order_count |
integer | |
plans |
array of objects | |
plans.url |
string (uri) | |
plans.uuid |
string (uuid) | |
plans.name |
string | |
plans.description |
string | |
plans.article_code |
string | |
plans.max_amount |
integer | Maximum number of plans that could be active. Plan is disabled when maximum amount is reached. |
plans.archived |
boolean | Forbids creation of new resources. |
plans.is_active |
boolean | |
plans.unit_price |
string (decimal) | |
plans.unit |
string | Enum: month, quarter, half_month, day, hour, quantity |
plans.init_price |
number (double) | |
plans.switch_price |
number (double) | |
plans.backend_id |
string | |
plans.organization_groups |
array of objects | |
plans.organization_groups.uuid |
string (uuid) | |
plans.organization_groups.url |
string (uri) | |
plans.organization_groups.name |
string | |
plans.organization_groups.parent_uuid |
string (uuid) | UUID of the parent organization group |
plans.organization_groups.parent_name |
string | Name of the parent organization group |
plans.organization_groups.parent |
string (uri) | |
plans.organization_groups.customers_count |
integer | Number of customers in this organization group |
plans.components |
array of objects | |
plans.components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
plans.components.name |
string | Display name for the measured unit, for example, Floating IP. |
plans.components.measured_unit |
string | Unit of measurement, for example, GB. |
plans.components.amount |
integer | |
plans.components.price |
string (decimal) | |
plans.components.future_price |
string (decimal) | |
plans.components.discount_threshold |
integer | Minimum amount to be eligible for discount. |
plans.components.discount_rate |
integer | Discount rate in percentage. |
plans.prices |
object (free-form) | |
plans.future_prices |
object (free-form) | |
plans.quotas |
object (free-form) | |
plans.resources_count |
integer | |
plans.plan_type |
string | |
plans.minimal_price |
number (double) | |
screenshots |
array of objects | |
screenshots.name |
string | |
screenshots.uuid |
string (uuid) | |
screenshots.description |
string | |
screenshots.image |
string (uri) | |
screenshots.thumbnail |
string (uri) | |
screenshots.created |
string (date-time) | |
type |
string | |
shared |
boolean | Accessible to all customers. |
billable |
boolean | Purchase and usage is invoiced. |
scope |
string | |
scope_uuid |
string (uuid) | |
scope_name |
string (uuid) | |
scope_state |
any | |
scope_error_message |
string | |
files |
array of objects | |
files.name |
string | |
files.created |
string (date-time) | |
files.file |
string (uri) | |
quotas |
array of objects | |
quotas.name |
string | |
quotas.usage |
integer | |
quotas.limit |
integer | |
paused_reason |
string | |
datacite_doi |
string | |
citation_count |
integer | Number of citations of a DOI |
latitude |
number (double) | |
longitude |
number (double) | |
country |
any | Country code (ISO 3166-1 alpha-2) |
backend_id |
string | |
organization_groups |
array of objects | |
organization_groups.uuid |
string (uuid) | |
organization_groups.url |
string (uri) | |
organization_groups.name |
string | |
organization_groups.parent_uuid |
string (uuid) | UUID of the parent organization group |
organization_groups.parent_name |
string | Name of the parent organization group |
organization_groups.parent |
string (uri) | |
organization_groups.customers_count |
integer | Number of customers in this organization group |
tags |
array of objects | |
tags.uuid |
string (uuid) | |
tags.name |
string | |
image |
string (uri) | |
total_customers |
integer | |
total_cost |
integer | |
total_cost_estimated |
integer | |
parent_description |
string | |
parent_uuid |
string (uuid) | |
parent_name |
string | |
backend_metadata |
any | |
has_compliance_requirements |
boolean | |
billing_type_classification |
string | Classify offering components by billing type. Returns 'limit_only', 'usage_only', or 'mixed'. |
compliance_checklist |
string (uri) | |
user_has_consent |
boolean | |
is_accessible |
boolean | |
google_calendar_is_public |
boolean | |
google_calendar_link |
string | Get the Google Calendar link for an offering. |
promotion_campaigns |
array of objects | |
promotion_campaigns.uuid |
string (uuid) | |
promotion_campaigns.name |
string | |
promotion_campaigns.start_date |
string (date) | Starting from this date, the campaign is active. |
promotion_campaigns.end_date |
string (date) | The last day the campaign is active. |
promotion_campaigns.discount_type |
string | Enum: discount, special_price |
promotion_campaigns.discount |
integer | |
promotion_campaigns.stock |
integer | |
promotion_campaigns.description |
string | |
promotion_campaigns.months |
integer | How many months in a row should the related service (when activated) get special deal (0 for indefinitely until active) |
promotion_campaigns.service_provider |
string (uri) |
List resource plan periods
Returns a list of active and future plan periods for the resource. Each period includes the plan details and current component usage.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- API Source:
marketplace_resources_plan_periods_list
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
plan_name |
string | |
plan_uuid |
string (uuid) | |
start |
string (date-time) | |
end |
string (date-time) | |
components |
array of objects | |
components.uuid |
string (uuid) | |
components.created |
string (date-time) | |
components.description |
string | |
components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
components.name |
string | Display name for the measured unit, for example, Floating IP. |
components.measured_unit |
string | Unit of measurement, for example, GB. |
components.usage |
string (decimal) | |
components.date |
string (date-time) | |
components.recurring |
boolean | Reported value is reused every month until changed. |
Get resource team
Returns a list of users connected to the project of this resource, including their project roles and offering-specific usernames.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- API Source:
marketplace_resources_team_list
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
full_name |
string | |
email |
string (email) | |
role |
string | |
expiration_time |
string (date-time) | |
offering_user_username |
string | |
offering_user_state |
any |
Naming
Suggest a resource name
Generates a suggested name for a new resource based on the project and offering. If the offering has a resource_name_pattern in plugin_options, it is used as a Python format string with variables: {customer_name}, {customer_slug}, {project_name}, {project_slug}, {offering_name}, {offering_slug}, {plan_name}, {counter}, and {attributes[KEY]} for any order form value.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
ResourceSuggestNameRequest - API Source:
marketplace_resources_suggest_name
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Field | Type | Required |
|---|---|---|
project |
string (uuid) | ✓ |
offering |
string (uuid) | ✓ |
plan |
string (uuid) | |
attributes |
any |
200 -
| Field | Type |
|---|---|
name |
string |
Other Actions
Get object state at a specific timestamp
Returns the state of the object as it was at the specified timestamp. Only accessible by staff and support users.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- API Source:
marketplace_resources_history_at_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Required | Description |
|---|---|---|---|
timestamp |
string | ✓ | ISO 8601 timestamp to query the object state at |
200 -
| Field | Type | Description |
|---|---|---|
id |
integer | Version ID |
revision_date |
string (date-time) | When this revision was created |
revision_user |
object (free-form) | User who created this revision |
revision_comment |
string | Comment describing the revision |
serialized_data |
object (free-form) | Serialized model fields at this revision |
400 -
404 -
Get version history
Returns the version history for this object. Only accessible by staff and support users.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
OrderState - Model Source:
ResourceOEnum - Model Source:
ResourceState - API Source:
marketplace_resources_history_list
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
backend_id |
string | Backend ID |
category_uuid |
string (uuid) | Category UUID |
component_count |
number | Filter by exact number of components |
created |
string (date-time) | Created after |
created_after |
string | Filter versions created after this timestamp (ISO 8601) |
created_before |
string | Filter versions created before this timestamp (ISO 8601) |
customer |
string (uri) | Customer URL |
customer_uuid |
string (uuid) | Customer UUID |
downscaled |
boolean | Downscaled |
has_terminate_date |
boolean | Has termination date |
is_attached |
boolean | Filter by attached state |
lexis_links_supported |
boolean | LEXIS links supported |
limit_based |
boolean | Filter by limit-based offerings |
limit_component_count |
number | Filter by exact number of limit-based components |
modified |
string (date-time) | Modified after |
name |
string | Name |
name_exact |
string | Name (exact) |
o |
array | Ordering |
offering |
string (uri) | |
offering_billable |
boolean | Offering billable |
offering_shared |
boolean | Offering shared |
offering_slug |
array | Multiple values may be separated by commas. |
offering_type |
string | Offering type |
offering_uuid |
array | Multiple values may be separated by commas. |
only_limit_based |
boolean | Filter resources with only limit-based components |
only_usage_based |
boolean | Filter resources with only usage-based components |
order_state |
array | Order state |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
parent_offering_uuid |
string (uuid) | |
paused |
boolean | Paused |
plan_uuid |
string (uuid) | Plan UUID |
project_name |
string | Project name |
project_uuid |
string (uuid) | Project UUID |
provider_uuid |
string (uuid) | Provider UUID |
query |
string | Search by resource UUID, name, slug, backend ID, effective ID, IPs or hypervisor |
restrict_member_access |
boolean | Restrict member access |
runtime_state |
string | Runtime state |
scope |
string (uri) | Filter by scope URL. |
service_manager_uuid |
string (uuid) | Service manager UUID |
state |
array | Resource state |
usage_based |
boolean | Filter by usage-based offerings |
visible_to_providers |
boolean | Include only resources visible to service providers |
visible_to_username |
string | Visible to username |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
id |
integer | Version ID |
revision_date |
string (date-time) | When this revision was created |
revision_user |
object (free-form) | User who created this revision |
revision_comment |
string | Comment describing the revision |
serialized_data |
object (free-form) | Serialized model fields at this revision |
Estimate renewal cost breakdown
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
RenewalEstimateRequestRequest - API Source:
marketplace_resources_estimate_renewal
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
extension_months |
integer | ✓ |
limits |
object (free-form) |
200 -
| Field | Type |
|---|---|
components |
array of objects |
components.component_type |
string |
components.component_name |
string |
components.billing_type |
string |
components.billing_period |
string |
components.current_limit |
integer |
components.new_limit |
integer |
components.unit_price |
string (decimal) |
components.measured_unit |
string |
components.period_description |
string |
components.total |
string (decimal) |
subscription_total |
string (decimal) |
limit_change_total |
string (decimal) |
total |
string (decimal) |
remaining_days |
integer |
new_end_date |
string (date) |
Reallocate resource limits
Creates marketplace orders to reallocate limits from source resource to target resources.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
ResourceReallocateLimitsRequest - API Source:
marketplace_resources_reallocate_limits
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
limits |
object (free-form) | ✓ |
targets |
array of objects | ✓ |
targets.resource_uuid |
string (uuid) | ✓ |
targets.allocated_limits |
object (free-form) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
source_order_uuid |
string (uuid) | UUID of the source order for limit reallocation |
target_order_uuids |
array of string (uuid)s | List of UUIDs for target orders receiving the reallocated limits |
Restore
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
ResourceRequest - API Source:
marketplace_resources_restore
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
offering |
string (uri) | ✓ | |
plan |
string (uri) | ||
name |
string | ✓ | |
slug |
string | URL-friendly identifier. Only editable by staff users. | |
end_date |
string (date) | The date is inclusive. Once reached, a resource will be scheduled for termination. | |
downscaled |
boolean | ||
paused |
boolean |
200 -
| Field | Type | Description |
|---|---|---|
offering |
string (uri) | |
offering_name |
string | |
offering_uuid |
string (uuid) | |
offering_description |
string | |
offering_image |
string (uri) | |
offering_thumbnail |
string (uri) | |
offering_type |
string | |
offering_shared |
boolean | Accessible to all customers. |
offering_billable |
boolean | Purchase and usage is invoiced. |
offering_plugin_options |
any | Public data used by specific plugin, such as storage mode for OpenStack. |
provider_name |
string | |
provider_uuid |
string (uuid) | |
provider_slug |
string | |
category_title |
string | |
category_uuid |
string (uuid) | |
category_icon |
string (uri) | |
plan |
string (uri) | |
plan_unit |
any | |
plan_name |
string | |
plan_uuid |
string (uuid) | |
plan_description |
string | |
attributes |
object (free-form) | |
limits |
object (free-form) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
modified |
string (date-time) | |
url |
string (uri) | |
scope |
string | |
description |
string | |
state |
any | |
resource_uuid |
string (uuid) | |
backend_id |
string | |
effective_id |
string | |
resource_type |
string | |
project |
string (uri) | |
project_uuid |
string (uuid) | |
project_name |
string | |
project_description |
string | |
project_end_date |
string (date) | The date is inclusive. Once reached, all project resource will be scheduled for termination. |
project_end_date_requested_by |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
offering_slug |
string | |
parent_offering_uuid |
string (uuid) | |
parent_offering_name |
string | |
parent_offering_slug |
string | |
offering_backend_id |
string | |
parent_uuid |
string (uuid) | |
parent_name |
string | |
backend_metadata |
any | |
is_usage_based |
boolean | Returns True if the resource has usage-based components that track variable consumption. |
is_limit_based |
boolean | Returns True if the resource has limit-based components with user-adjustable quotas. |
name |
string | |
slug |
string | URL-friendly identifier. Only editable by staff users. |
current_usages |
object (free-form) | Dictionary mapping component types to their latest reported usage amounts. |
can_terminate |
boolean | |
report |
array of objects | |
report.header |
string | Section header text |
report.body |
string | Section body content |
end_date |
string (date) | The date is inclusive. Once reached, a resource will be scheduled for termination. |
end_date_requested_by |
string (uri) | |
username |
string | |
limit_usage |
object (free-form) | Dictionary mapping limit-based component types to their consumed usage. For monthly periods, maps from current_usages; for longer periods, aggregates historical usage. |
downscaled |
boolean | |
restrict_member_access |
boolean | |
paused |
boolean | |
endpoints |
array of objects | |
endpoints.uuid |
string (uuid) | |
endpoints.name |
string | |
endpoints.url |
string | URL of the access endpoint |
error_message |
string | |
error_traceback |
string | |
options |
any | |
available_actions |
array of strings | |
last_sync |
string (date-time) | |
order_in_progress |
any | |
creation_order |
any | |
service_settings_uuid |
string (uuid) | |
project_slug |
string | |
customer_slug |
string | |
user_requires_reconsent |
boolean | Check if the current user needs to re-consent for this resource's offering. |
renewal_date |
object (free-form) | |
offering_state |
any | |
offering_components |
array of objects | |
offering_components.uuid |
string (uuid) | |
offering_components.billing_type |
string | Enum: fixed, usage, limit, one, few |
offering_components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
offering_components.name |
string | Display name for the measured unit, for example, Floating IP. |
offering_components.description |
string | |
offering_components.measured_unit |
string | Unit of measurement, for example, GB. |
offering_components.unit_factor |
integer | The conversion factor from backend units to measured_unit |
offering_components.limit_period |
any | |
offering_components.limit_amount |
integer | |
offering_components.article_code |
string | |
offering_components.max_value |
integer | |
offering_components.min_value |
integer | |
offering_components.max_available_limit |
integer | |
offering_components.is_boolean |
boolean | |
offering_components.default_limit |
integer | |
offering_components.factor |
integer | |
offering_components.is_builtin |
boolean | |
offering_components.is_prepaid |
boolean | |
offering_components.overage_component |
string (uuid) | |
offering_components.min_prepaid_duration |
integer | |
offering_components.max_prepaid_duration |
integer |
Marketplace Runtime States
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/marketplace-runtime-states/ |
List available runtime states for resources |
List available runtime states for resources
1 2 3 4 | |
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
marketplace_runtime_states_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
category_uuid |
string (uuid) | Filter runtime states by resources belonging to a specific category. |
project_uuid |
string (uuid) | Filter runtime states by resources within a specific project. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
value |
string | Value of the runtime state |
label |
string | Human-readable label for the runtime state |
Site agent
Backend Resource Requests
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/backend-resource-requests/ |
List backend resource requests |
| GET | /api/backend-resource-requests/{uuid}/ |
Retrieve a backend resource request |
| POST | /api/backend-resource-requests/ |
Create a backend resource request |
| Other Actions | ||
| POST | /api/backend-resource-requests/{uuid}/set_done/ |
Mark a request as done |
| POST | /api/backend-resource-requests/{uuid}/set_erred/ |
Mark a request as erred |
| POST | /api/backend-resource-requests/{uuid}/start_processing/ |
Start processing a request |
Core CRUD
List backend resource requests
Returns a paginated list of requests for backend resources.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- Model Source:
BackendResourceReqOEnum - Model Source:
BackendResourceReqStateEnum - API Source:
backend_resource_requests_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
created |
string (date-time) | Created after |
finished |
string (date-time) | Modified after |
modified |
string (date-time) | Modified after |
o |
array | Ordering |
offering_uuid |
string (uuid) | Offering UUID |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
started |
string (date-time) | Created after |
state |
array | Backend resource request state |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
modified |
string (date-time) | |
started |
string (date-time) | Time when request processing started |
finished |
string (date-time) | Time when request processing finished |
state |
any | |
offering |
string (uuid) | |
offering_name |
string | |
offering_url |
string (uri) | |
error_message |
string | |
error_traceback |
string |
Retrieve a backend resource request
Returns the details of a specific backend resource request.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
backend_resource_requests_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
modified |
string (date-time) | |
started |
string (date-time) | Time when request processing started |
finished |
string (date-time) | Time when request processing finished |
state |
any | |
offering |
string (uuid) | |
offering_name |
string | |
offering_url |
string (uri) | |
error_message |
string | |
error_traceback |
string |
Create a backend resource request
Creates a new request to fetch a list of importable resources from a backend. This is typically used by staff to trigger a site agent to report available resources.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
- Model Source:
BackendResourceReqRequest - API Source:
backend_resource_requests_create
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Field | Type | Required |
|---|---|---|
offering |
string (uuid) | ✓ |
201 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
modified |
string (date-time) | |
started |
string (date-time) | Time when request processing started |
finished |
string (date-time) | Time when request processing finished |
state |
any | |
offering |
string (uuid) | |
offering_name |
string | |
offering_url |
string (uri) | |
error_message |
string | |
error_traceback |
string |
Other Actions
Mark a request as done
Transitions the request state from 'Processing' to 'Done'. This is used by a site agent to signal that it has successfully reported all available resources.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
backend_resource_requests_set_done
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
status |
string |
Mark a request as erred
Transitions the request state to 'Erred'. This is used by a site agent to report a failure during the resource fetching process. An error message and traceback should be provided.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
BackendResourceRequestSetErredRequest - API Source:
backend_resource_requests_set_erred
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
error_message |
string | |
error_traceback |
string |
200 -
| Field | Type |
|---|---|
status |
string |
Start processing a request
Transitions the request state from 'Sent' to 'Processing'. This is used by a site agent to acknowledge that it has started fetching the resource list.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
backend_resource_requests_start_processing
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
status |
string |
Backend Resources
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/backend-resources/ |
List backend resources |
| GET | /api/backend-resources/{uuid}/ |
Retrieve a backend resource |
| POST | /api/backend-resources/ |
Create a backend resource |
| DELETE | /api/backend-resources/{uuid}/ |
Delete a backend resource |
| Other Actions | ||
| POST | /api/backend-resources/{uuid}/import_resource/ |
Import a backend resource (staff only) |
Core CRUD
List backend resources
Returns a paginated list of backend resources that are available for import. This endpoint is typically used by site agents to see which resources they have reported.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 | |
- Model Source:
BackendResourceReqOEnum - API Source:
backend_resources_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
backend_id |
string | Backend ID |
created |
string (date-time) | Created after |
modified |
string (date-time) | Modified after |
name |
string | Name |
name_exact |
string | Name (exact) |
o |
array | Ordering |
offering_uuid |
string (uuid) | Offering UUID |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
project_uuid |
string (uuid) | Project UUID |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
created |
string (date-time) |
modified |
string (date-time) |
project |
string (uuid) |
project_name |
string |
project_url |
string (uri) |
offering |
string (uuid) |
offering_name |
string |
offering_url |
string (uri) |
backend_id |
string |
backend_metadata |
any |
Retrieve a backend resource
Returns the details of a specific backend resource.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
backend_resources_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
created |
string (date-time) |
modified |
string (date-time) |
project |
string (uuid) |
project_name |
string |
project_url |
string (uri) |
offering |
string (uuid) |
offering_name |
string |
offering_url |
string (uri) |
backend_id |
string |
backend_metadata |
any |
Create a backend resource
Creates a new backend resource record. This is typically done by a site agent to report a resource that is available for import into the marketplace.
1 2 3 4 5 6 7 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
BackendResourceRequest - API Source:
backend_resources_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
| Field | Type | Required |
|---|---|---|
name |
string | ✓ |
project |
string (uuid) | ✓ |
offering |
string (uuid) | ✓ |
backend_id |
string | |
backend_metadata |
any |
201 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
created |
string (date-time) |
modified |
string (date-time) |
project |
string (uuid) |
project_name |
string |
project_url |
string (uri) |
offering |
string (uuid) |
offering_name |
string |
offering_url |
string (uri) |
backend_id |
string |
backend_metadata |
any |
Delete a backend resource
Deletes a backend resource record. This is typically done when the resource is no longer available for import.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
backend_resources_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
Import a backend resource (staff only)
1 2 3 | |
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
BackendResourceImportRequest - API Source:
backend_resources_import_resource
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
plan |
string (uuid) |
201 -
| Field | Type | Description |
|---|---|---|
offering |
string (uri) | |
offering_name |
string | |
offering_uuid |
string (uuid) | |
offering_description |
string | |
offering_image |
string (uri) | |
offering_thumbnail |
string (uri) | |
offering_type |
string | |
offering_shared |
boolean | Accessible to all customers. |
offering_billable |
boolean | Purchase and usage is invoiced. |
offering_plugin_options |
any | Public data used by specific plugin, such as storage mode for OpenStack. |
provider_name |
string | |
provider_uuid |
string (uuid) | |
provider_slug |
string | |
category_title |
string | |
category_uuid |
string (uuid) | |
category_icon |
string (uri) | |
plan |
string (uri) | |
plan_unit |
any | |
plan_name |
string | |
plan_uuid |
string (uuid) | |
plan_description |
string | |
attributes |
object (free-form) | |
limits |
object (free-form) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
modified |
string (date-time) | |
url |
string (uri) | |
scope |
string | |
description |
string | |
state |
any | |
resource_uuid |
string (uuid) | |
backend_id |
string | |
effective_id |
string | |
resource_type |
string | |
project |
string (uri) | |
project_uuid |
string (uuid) | |
project_name |
string | |
project_description |
string | |
project_end_date |
string (date) | The date is inclusive. Once reached, all project resource will be scheduled for termination. |
project_end_date_requested_by |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
offering_slug |
string | |
parent_offering_uuid |
string (uuid) | |
parent_offering_name |
string | |
parent_offering_slug |
string | |
offering_backend_id |
string | |
parent_uuid |
string (uuid) | |
parent_name |
string | |
backend_metadata |
any | |
is_usage_based |
boolean | Returns True if the resource has usage-based components that track variable consumption. |
is_limit_based |
boolean | Returns True if the resource has limit-based components with user-adjustable quotas. |
name |
string | |
slug |
string | URL-friendly identifier. Only editable by staff users. |
current_usages |
object (free-form) | Dictionary mapping component types to their latest reported usage amounts. |
can_terminate |
boolean | |
report |
array of objects | |
report.header |
string | Section header text |
report.body |
string | Section body content |
end_date |
string (date) | The date is inclusive. Once reached, a resource will be scheduled for termination. |
end_date_requested_by |
string (uri) | |
username |
string | |
limit_usage |
object (free-form) | Dictionary mapping limit-based component types to their consumed usage. For monthly periods, maps from current_usages; for longer periods, aggregates historical usage. |
downscaled |
boolean | |
restrict_member_access |
boolean | |
paused |
boolean | |
endpoints |
array of objects | |
endpoints.uuid |
string (uuid) | |
endpoints.name |
string | |
endpoints.url |
string | URL of the access endpoint |
error_message |
string | |
error_traceback |
string | |
options |
any | |
available_actions |
array of strings | |
last_sync |
string (date-time) | |
order_in_progress |
any | |
creation_order |
any | |
service_settings_uuid |
string (uuid) | |
project_slug |
string | |
customer_slug |
string | |
user_requires_reconsent |
boolean | Check if the current user needs to re-consent for this resource's offering. |
renewal_date |
object (free-form) | |
offering_state |
any | |
offering_components |
array of objects | |
offering_components.uuid |
string (uuid) | |
offering_components.billing_type |
string | Enum: fixed, usage, limit, one, few |
offering_components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
offering_components.name |
string | Display name for the measured unit, for example, Floating IP. |
offering_components.description |
string | |
offering_components.measured_unit |
string | Unit of measurement, for example, GB. |
offering_components.unit_factor |
integer | The conversion factor from backend units to measured_unit |
offering_components.limit_period |
any | |
offering_components.limit_amount |
integer | |
offering_components.article_code |
string | |
offering_components.max_value |
integer | |
offering_components.min_value |
integer | |
offering_components.max_available_limit |
integer | |
offering_components.is_boolean |
boolean | |
offering_components.default_limit |
integer | |
offering_components.factor |
integer | |
offering_components.is_builtin |
boolean | |
offering_components.is_prepaid |
boolean | |
offering_components.overage_component |
string (uuid) | |
offering_components.min_prepaid_duration |
integer | |
offering_components.max_prepaid_duration |
integer |
Marketplace Site Agent Connection Stats
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/marketplace-site-agent-connection-stats/ |
Get agent connection statistics |
Get agent connection statistics
Returns connection status for all registered agents.
For each agent identity, provides: - Agent metadata (name, version, offering) - Services and their states - Event subscriptions with RabbitMQ connection status - RabbitMQ queues associated with the agent's offering
The RMQ connection data includes: - Whether the agent is currently connected - Connection source IP, timestamp, and state - Traffic statistics (bytes sent/received)
Requires support user permissions.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
- API Source:
marketplace_site_agent_connection_stats_retrieve
1 2 3 4 5 6 7 8 9 10 | |
200 -
| Field | Type | Description |
|---|---|---|
agents |
array of objects | List of agents with connection status |
agents.uuid |
string (uuid) | Agent identity UUID |
agents.name |
string | Agent name |
agents.offering_uuid |
string (uuid) | Associated offering UUID |
agents.offering_name |
string | Associated offering name |
agents.version |
string | Agent version |
agents.last_restarted |
string (date-time) | When the agent was last restarted |
agents.services |
array of objects | Services running within this agent |
agents.services.uuid |
string (uuid) | Service UUID |
agents.services.name |
string | Service name |
agents.services.state |
string | Service state: ACTIVE, IDLE, or ERROR |
agents.services.modified |
string (date-time) | Last modification timestamp |
agents.event_subscriptions |
array of objects | Event subscriptions with connection status |
agents.event_subscriptions.uuid |
string (uuid) | Event subscription UUID |
agents.event_subscriptions.created |
string (date-time) | When the subscription was created |
agents.event_subscriptions.observable_objects |
any | List of observable object configurations |
agents.event_subscriptions.rmq_connection |
any | RabbitMQ connection status for this subscription |
agents.queues |
array of objects | RabbitMQ queues for this agent's offering |
agents.queues.name |
string | Queue name |
agents.queues.messages |
integer | Number of messages in queue |
agents.queues.consumers |
integer | Number of active consumers |
agents.queues.object_type |
string | Parsed object type from queue name |
summary |
any | Summary statistics |
503 -
Marketplace Site Agent Identities
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/marketplace-site-agent-identities/ |
List Marketplace Site Agent Identities |
| GET | /api/marketplace-site-agent-identities/{uuid}/ |
Retrieve |
| POST | /api/marketplace-site-agent-identities/ |
Create |
| PUT | /api/marketplace-site-agent-identities/{uuid}/ |
Update |
| DELETE | /api/marketplace-site-agent-identities/{uuid}/ |
Delete |
| Other Actions | ||
| POST | /api/marketplace-site-agent-identities/cleanup_orphaned/ |
Remove agent identities that have no active services. Staff only |
| POST | /api/marketplace-site-agent-identities/{uuid}/register_event_subscription/ |
Register event subscription |
| POST | /api/marketplace-site-agent-identities/{uuid}/register_service/ |
Register a new processor or get the existing one for the agent service |
Core CRUD
List Marketplace Site Agent Identities
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
marketplace_site_agent_identities_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
last_restarted |
string (date-time) | Last restarted after |
name |
string | |
offering_uuid |
string (uuid) | |
orphaned |
boolean | Has no services |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
version |
string |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
offering |
string (uuid) | UUID of an offering with a site-agent compatible type. |
name |
string | |
version |
string | |
dependencies |
any | |
config_file_path |
string | Example: '/etc/waldur/agent.yaml' |
config_file_content |
string | |
last_restarted |
string (date-time) | |
created |
string (date-time) | |
modified |
string (date-time) | |
services |
array of objects | |
services.uuid |
string (uuid) | |
services.url |
string (uri) | |
services.name |
string | |
services.mode |
string | |
services.state |
any | |
services.statistics |
any | |
services.created |
string (date-time) | |
services.modified |
string (date-time) |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_site_agent_identities_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
offering |
string (uuid) | UUID of an offering with a site-agent compatible type. |
name |
string | |
version |
string | |
dependencies |
any | |
config_file_path |
string | Example: '/etc/waldur/agent.yaml' |
config_file_content |
string | |
last_restarted |
string (date-time) | |
created |
string (date-time) | |
modified |
string (date-time) | |
services |
array of objects | |
services.uuid |
string (uuid) | |
services.url |
string (uri) | |
services.name |
string | |
services.mode |
string | |
services.state |
any | |
services.statistics |
any | |
services.created |
string (date-time) | |
services.modified |
string (date-time) |
Create
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
AgentIdentityRequest - API Source:
marketplace_site_agent_identities_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Field | Type | Required | Description |
|---|---|---|---|
offering |
string (uuid) | ✓ | UUID of an offering with a site-agent compatible type. |
name |
string | ✓ | |
version |
string | ||
dependencies |
any | ||
config_file_path |
string | Example: '/etc/waldur/agent.yaml' | |
config_file_content |
string | ||
last_restarted |
string (date-time) |
201 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
offering |
string (uuid) | UUID of an offering with a site-agent compatible type. |
name |
string | |
version |
string | |
dependencies |
any | |
config_file_path |
string | Example: '/etc/waldur/agent.yaml' |
config_file_content |
string | |
last_restarted |
string (date-time) | |
created |
string (date-time) | |
modified |
string (date-time) | |
services |
array of objects | |
services.uuid |
string (uuid) | |
services.url |
string (uri) | |
services.name |
string | |
services.mode |
string | |
services.state |
any | |
services.statistics |
any | |
services.created |
string (date-time) | |
services.modified |
string (date-time) |
Update
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
AgentIdentityRequest - API Source:
marketplace_site_agent_identities_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
offering |
string (uuid) | ✓ | UUID of an offering with a site-agent compatible type. |
name |
string | ✓ | |
version |
string | ||
dependencies |
any | ||
config_file_path |
string | Example: '/etc/waldur/agent.yaml' | |
config_file_content |
string | ||
last_restarted |
string (date-time) |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
offering |
string (uuid) | UUID of an offering with a site-agent compatible type. |
name |
string | |
version |
string | |
dependencies |
any | |
config_file_path |
string | Example: '/etc/waldur/agent.yaml' |
config_file_content |
string | |
last_restarted |
string (date-time) | |
created |
string (date-time) | |
modified |
string (date-time) | |
services |
array of objects | |
services.uuid |
string (uuid) | |
services.url |
string (uri) | |
services.name |
string | |
services.mode |
string | |
services.state |
any | |
services.statistics |
any | |
services.created |
string (date-time) | |
services.modified |
string (date-time) |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_site_agent_identities_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
Remove agent identities that have no active services. Staff only
Remove agent identities that have no active services. Staff only.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
- Model Source:
CleanupRequestRequest - API Source:
marketplace_site_agent_identities_cleanup_orphaned
1 2 3 4 5 6 7 8 9 10 | |
| Field | Type | Required | Description |
|---|---|---|---|
dry_run |
boolean | If true, only return what would be deleted without actually deleting Constraints: default: True |
|
older_than_hours |
integer | Delete entries older than this many hours Constraints: default: 24 |
200 -
| Field | Type | Description |
|---|---|---|
deleted_count |
integer | Number of items deleted (or would be deleted in dry run) |
dry_run |
boolean | Whether this was a dry run |
items |
array of objects | List of deleted (or to-be-deleted) items |
Register event subscription
Register an event subscription for the specified agent identity and observable object type. Returns existing subscription if already exists.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
AgentEventSubscriptionCreateRequest - API Source:
marketplace_site_agent_identities_register_event_subscription
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
observable_object_type |
any | ✓ | The type of object to observe for events |
description |
string | Optional description for the event subscription |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
description |
string | |
user |
string (uri) | |
user_uuid |
string (uuid) | |
user_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
user_full_name |
string | |
observable_objects |
any | List of objects to observe. Each item must have 'object_type' (one of: order, user_role, resource, offering_user, importable_resources, service_account, course_account, resource_periodic_limits) and optionally 'object_id' (integer). Example: [{"object_type": "resource"}, {"object_type": "order", "object_id": 123}] |
created |
string (date-time) | |
modified |
string (date-time) | |
source_ip |
any | An IPv4 or IPv6 address. |
201 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
description |
string | |
user |
string (uri) | |
user_uuid |
string (uuid) | |
user_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
user_full_name |
string | |
observable_objects |
any | List of objects to observe. Each item must have 'object_type' (one of: order, user_role, resource, offering_user, importable_resources, service_account, course_account, resource_periodic_limits) and optionally 'object_id' (integer). Example: [{"object_type": "resource"}, {"object_type": "order", "object_id": 123}] |
created |
string (date-time) | |
modified |
string (date-time) | |
source_ip |
any | An IPv4 or IPv6 address. |
Register a new processor or get the existing one for the agent service
Register a new processor or get the existing one for the agent service
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
AgentServiceCreateRequest - API Source:
marketplace_site_agent_identities_register_service
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
name |
string | ✓ |
mode |
string |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
identity |
string (uuid) | |
identity_name |
string | |
name |
string | |
mode |
string | |
state |
any | |
statistics |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
processors |
array of objects | |
processors.uuid |
string (uuid) | |
processors.url |
string (uri) | |
processors.name |
string | |
processors.last_run |
string (date-time) | |
processors.backend_type |
string | Type of the backend, for example SLURM. |
processors.backend_version |
string | |
processors.created |
string (date-time) | |
processors.modified |
string (date-time) |
201 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
identity |
string (uuid) | |
identity_name |
string | |
name |
string | |
mode |
string | |
state |
any | |
statistics |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
processors |
array of objects | |
processors.uuid |
string (uuid) | |
processors.url |
string (uri) | |
processors.name |
string | |
processors.last_run |
string (date-time) | |
processors.backend_type |
string | Type of the backend, for example SLURM. |
processors.backend_version |
string | |
processors.created |
string (date-time) | |
processors.modified |
string (date-time) |
Marketplace Site Agent Processors
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/marketplace-site-agent-processors/ |
List Marketplace Site Agent Processors |
| GET | /api/marketplace-site-agent-processors/{uuid}/ |
Retrieve |
| DELETE | /api/marketplace-site-agent-processors/{uuid}/ |
Delete |
List Marketplace Site Agent Processors
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
marketplace_site_agent_processors_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
backend_type |
string | |
backend_version |
string | |
last_run |
string (date-time) | Last run after |
last_run_before |
string (date-time) | Last run before |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
service_uuid |
string (uuid) | |
stale |
boolean | Last run more than 1 hour ago |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
service |
string (uuid) | |
service_name |
string | |
name |
string | |
last_run |
string (date-time) | |
backend_type |
string | Type of the backend, for example SLURM. |
backend_version |
string | |
created |
string (date-time) | |
modified |
string (date-time) |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_site_agent_processors_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
service |
string (uuid) | |
service_name |
string | |
name |
string | |
last_run |
string (date-time) | |
backend_type |
string | Type of the backend, for example SLURM. |
backend_version |
string | |
created |
string (date-time) | |
modified |
string (date-time) |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_site_agent_processors_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Marketplace Site Agent Services
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/marketplace-site-agent-services/ |
List Marketplace Site Agent Services |
| GET | /api/marketplace-site-agent-services/{uuid}/ |
Retrieve |
| DELETE | /api/marketplace-site-agent-services/{uuid}/ |
Delete |
| Other Actions | ||
| POST | /api/marketplace-site-agent-services/cleanup_stale/ |
Remove agent services that have been inactive for a specified time. Staff only |
| POST | /api/marketplace-site-agent-services/{uuid}/register_processor/ |
Register a new processor for the agent service |
| POST | /api/marketplace-site-agent-services/{uuid}/set_statistics/ |
Update statistics for the agent service |
Core CRUD
List Marketplace Site Agent Services
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 | |
- Model Source:
AgentServiceStateEnum - API Source:
marketplace_site_agent_services_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
identity_uuid |
string (uuid) | |
mode |
string | |
modified_after |
string (date-time) | Modified after |
modified_before |
string (date-time) | Modified before |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
stale |
boolean | Inactive for more than 24 hours |
state |
array |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
identity |
string (uuid) | |
identity_name |
string | |
name |
string | |
mode |
string | |
state |
any | |
statistics |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
processors |
array of objects | |
processors.uuid |
string (uuid) | |
processors.url |
string (uri) | |
processors.name |
string | |
processors.last_run |
string (date-time) | |
processors.backend_type |
string | Type of the backend, for example SLURM. |
processors.backend_version |
string | |
processors.created |
string (date-time) | |
processors.modified |
string (date-time) |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_site_agent_services_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
identity |
string (uuid) | |
identity_name |
string | |
name |
string | |
mode |
string | |
state |
any | |
statistics |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
processors |
array of objects | |
processors.uuid |
string (uuid) | |
processors.url |
string (uri) | |
processors.name |
string | |
processors.last_run |
string (date-time) | |
processors.backend_type |
string | Type of the backend, for example SLURM. |
processors.backend_version |
string | |
processors.created |
string (date-time) | |
processors.modified |
string (date-time) |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_site_agent_services_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
Remove agent services that have been inactive for a specified time. Staff only
Remove agent services that have been inactive for a specified time. Staff only.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
- Model Source:
CleanupRequestRequest - API Source:
marketplace_site_agent_services_cleanup_stale
1 2 3 4 5 6 7 8 9 10 | |
| Field | Type | Required | Description |
|---|---|---|---|
dry_run |
boolean | If true, only return what would be deleted without actually deleting Constraints: default: True |
|
older_than_hours |
integer | Delete entries older than this many hours Constraints: default: 24 |
200 -
| Field | Type | Description |
|---|---|---|
deleted_count |
integer | Number of items deleted (or would be deleted in dry run) |
dry_run |
boolean | Whether this was a dry run |
items |
array of objects | List of deleted (or to-be-deleted) items |
Register a new processor for the agent service
Register a new processor for the agent service
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
AgentProcessorCreateRequest - API Source:
marketplace_site_agent_services_register_processor
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ✓ | |
backend_type |
string | ✓ | Type of the backend, for example SLURM. |
backend_version |
string |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
service |
string (uuid) | |
service_name |
string | |
name |
string | |
last_run |
string (date-time) | |
backend_type |
string | Type of the backend, for example SLURM. |
backend_version |
string | |
created |
string (date-time) | |
modified |
string (date-time) |
201 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
service |
string (uuid) | |
service_name |
string | |
name |
string | |
last_run |
string (date-time) | |
backend_type |
string | Type of the backend, for example SLURM. |
backend_version |
string | |
created |
string (date-time) | |
modified |
string (date-time) |
Update statistics for the agent service
Update statistics for the agent service
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
AgentServiceStatisticsRequest - API Source:
marketplace_site_agent_services_set_statistics
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
statistics |
any | ✓ | Statistics data to be stored for the service |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
identity |
string (uuid) | |
identity_name |
string | |
name |
string | |
mode |
string | |
state |
any | |
statistics |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
processors |
array of objects | |
processors.uuid |
string (uuid) | |
processors.url |
string (uri) | |
processors.name |
string | |
processors.last_run |
string (date-time) | |
processors.backend_type |
string | Type of the backend, for example SLURM. |
processors.backend_version |
string | |
processors.created |
string (date-time) | |
processors.modified |
string (date-time) |
Marketplace Site Agent Stats
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/marketplace-site-agent-stats/ |
List Marketplace Site Agent Stats |
List Marketplace Site Agent Stats
Get aggregated statistics about agent identities, services, and processors. Support users only.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
- API Source:
marketplace_site_agent_stats_retrieve
1 2 3 4 5 6 7 8 9 10 | |
200 -
| Field | Type | Description |
|---|---|---|
identities |
object (free-form) | Statistics about agent identities |
services |
object (free-form) | Statistics about agent services |
processors |
object (free-form) | Statistics about agent processors |
Marketplace Site Agent Task Stats
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/marketplace-site-agent-task-stats/ |
Get Celery task status for agent-related tasks. Support users only |
Get Celery task status for agent-related tasks. Support users only
Get Celery task status for agent-related tasks. Support users only.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
- API Source:
marketplace_site_agent_task_stats_retrieve
1 2 3 4 5 6 7 8 9 10 | |
200 -
| Field | Type | Description |
|---|---|---|
active_tasks |
array of objects | Currently running agent-related tasks |
scheduled_tasks |
array of objects | Scheduled agent-related tasks |
reserved_tasks |
array of objects | Reserved agent-related tasks |
error |
string | Error message if task inspection failed |
Software management
Marketplace Software Catalogs
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/marketplace-software-catalogs/ |
List software catalogs |
| GET | /api/marketplace-software-catalogs/{uuid}/ |
Retrieve a software catalog |
| POST | /api/marketplace-software-catalogs/ |
Create a software catalog |
| POST | /api/marketplace-software-catalogs/{uuid}/update_catalog/ |
Trigger async update for an existing catalog |
| PUT | /api/marketplace-software-catalogs/{uuid}/ |
Update a software catalog |
| PATCH | /api/marketplace-software-catalogs/{uuid}/ |
Partially update a software catalog |
| DELETE | /api/marketplace-software-catalogs/{uuid}/ |
Delete a software catalog |
| Other Actions | ||
| GET | /api/marketplace-software-catalogs/discover/ |
Discover available software catalog versions |
| POST | /api/marketplace-software-catalogs/import_catalog/ |
Import a new software catalog |
Core CRUD
List software catalogs
Returns a paginated list of available software catalogs, such as EESSI or Spack.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 | |
- Model Source:
SoftwareCatalogOEnum - API Source:
marketplace_software_catalogs_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
name |
string | |
o |
array | Ordering |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
version |
string |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
modified |
string (date-time) | |
name |
string | Catalog name (e.g., EESSI, Spack) |
version |
string | Catalog version (e.g., 2023.06, 0.21.0) |
catalog_type |
any | Type of software catalog |
catalog_type_display |
string | |
source_url |
string (uri) | Catalog source URL |
description |
string | |
metadata |
any | Catalog-specific metadata (architecture maps, API endpoints, etc.) |
auto_update_enabled |
boolean | Whether to automatically update this catalog via scheduled tasks |
last_update_attempt |
string (date-time) | |
last_successful_update |
string (date-time) | |
update_errors |
string | |
package_count |
integer | |
version_count |
integer | |
target_count |
integer |
Retrieve a software catalog
Returns the details of a specific software catalog, including its name, version, and the number of packages it contains.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_software_catalogs_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
modified |
string (date-time) | |
name |
string | Catalog name (e.g., EESSI, Spack) |
version |
string | Catalog version (e.g., 2023.06, 0.21.0) |
catalog_type |
any | Type of software catalog |
catalog_type_display |
string | |
source_url |
string (uri) | Catalog source URL |
description |
string | |
metadata |
any | Catalog-specific metadata (architecture maps, API endpoints, etc.) |
auto_update_enabled |
boolean | Whether to automatically update this catalog via scheduled tasks |
last_update_attempt |
string (date-time) | |
last_successful_update |
string (date-time) | |
update_errors |
string | |
package_count |
integer | |
version_count |
integer | |
target_count |
integer |
Create a software catalog
Creates a new software catalog. Requires staff permissions.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
SoftwareCatalogRequest - API Source:
marketplace_software_catalogs_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ✓ | Catalog name (e.g., EESSI, Spack) |
version |
string | ✓ | Catalog version (e.g., 2023.06, 0.21.0) |
catalog_type |
any | Type of software catalog Constraints: default: binary_runtime |
|
source_url |
string (uri) | Catalog source URL | |
description |
string | ||
metadata |
any | Catalog-specific metadata (architecture maps, API endpoints, etc.) | |
auto_update_enabled |
boolean | Whether to automatically update this catalog via scheduled tasks | |
update_errors |
string |
201 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
modified |
string (date-time) | |
name |
string | Catalog name (e.g., EESSI, Spack) |
version |
string | Catalog version (e.g., 2023.06, 0.21.0) |
catalog_type |
any | Type of software catalog |
catalog_type_display |
string | |
source_url |
string (uri) | Catalog source URL |
description |
string | |
metadata |
any | Catalog-specific metadata (architecture maps, API endpoints, etc.) |
auto_update_enabled |
boolean | Whether to automatically update this catalog via scheduled tasks |
last_update_attempt |
string (date-time) | |
last_successful_update |
string (date-time) | |
update_errors |
string | |
package_count |
integer | |
version_count |
integer | |
target_count |
integer |
Trigger async update for an existing catalog
Triggers a Celery task to update the given catalog from its upstream source. Returns 202 Accepted immediately. Staff only.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
SoftwareCatalogRequest - API Source:
marketplace_software_catalogs_update_catalog
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ✓ | Catalog name (e.g., EESSI, Spack) |
version |
string | ✓ | Catalog version (e.g., 2023.06, 0.21.0) |
catalog_type |
any | Type of software catalog Constraints: default: binary_runtime |
|
source_url |
string (uri) | Catalog source URL | |
description |
string | ||
metadata |
any | Catalog-specific metadata (architecture maps, API endpoints, etc.) | |
auto_update_enabled |
boolean | Whether to automatically update this catalog via scheduled tasks | |
update_errors |
string |
202 - No response body
Update a software catalog
Updates an existing software catalog. Requires staff permissions.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
SoftwareCatalogRequest - API Source:
marketplace_software_catalogs_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ✓ | Catalog name (e.g., EESSI, Spack) |
version |
string | ✓ | Catalog version (e.g., 2023.06, 0.21.0) |
catalog_type |
any | Type of software catalog Constraints: default: binary_runtime |
|
source_url |
string (uri) | Catalog source URL | |
description |
string | ||
metadata |
any | Catalog-specific metadata (architecture maps, API endpoints, etc.) | |
auto_update_enabled |
boolean | Whether to automatically update this catalog via scheduled tasks | |
update_errors |
string |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
modified |
string (date-time) | |
name |
string | Catalog name (e.g., EESSI, Spack) |
version |
string | Catalog version (e.g., 2023.06, 0.21.0) |
catalog_type |
any | Type of software catalog |
catalog_type_display |
string | |
source_url |
string (uri) | Catalog source URL |
description |
string | |
metadata |
any | Catalog-specific metadata (architecture maps, API endpoints, etc.) |
auto_update_enabled |
boolean | Whether to automatically update this catalog via scheduled tasks |
last_update_attempt |
string (date-time) | |
last_successful_update |
string (date-time) | |
update_errors |
string | |
package_count |
integer | |
version_count |
integer | |
target_count |
integer |
Partially update a software catalog
Partially updates an existing software catalog. Requires staff permissions.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedSoftwareCatalogRequest - API Source:
marketplace_software_catalogs_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | Catalog name (e.g., EESSI, Spack) | |
version |
string | Catalog version (e.g., 2023.06, 0.21.0) | |
catalog_type |
any | Type of software catalog Constraints: default: binary_runtime |
|
source_url |
string (uri) | Catalog source URL | |
description |
string | ||
metadata |
any | Catalog-specific metadata (architecture maps, API endpoints, etc.) | |
auto_update_enabled |
boolean | Whether to automatically update this catalog via scheduled tasks | |
update_errors |
string |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
modified |
string (date-time) | |
name |
string | Catalog name (e.g., EESSI, Spack) |
version |
string | Catalog version (e.g., 2023.06, 0.21.0) |
catalog_type |
any | Type of software catalog |
catalog_type_display |
string | |
source_url |
string (uri) | Catalog source URL |
description |
string | |
metadata |
any | Catalog-specific metadata (architecture maps, API endpoints, etc.) |
auto_update_enabled |
boolean | Whether to automatically update this catalog via scheduled tasks |
last_update_attempt |
string (date-time) | |
last_successful_update |
string (date-time) | |
update_errors |
string | |
package_count |
integer | |
version_count |
integer | |
target_count |
integer |
Delete a software catalog
Deletes a software catalog. Requires staff permissions.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_software_catalogs_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
Discover available software catalog versions
Queries upstream sources (EESSI, Spack) for available catalog versions without creating anything. Returns detected versions and whether an update is available compared to existing database records.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 | |
- Model Source:
SoftwareCatalogOEnum - API Source:
marketplace_software_catalogs_discover_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
name |
string | |
o |
array | Ordering |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
version |
string |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
name |
string |
catalog_type |
string |
latest_version |
string |
existing |
boolean |
existing_version |
string |
update_available |
boolean |
Import a new software catalog
Creates a new catalog record and triggers async data loading via Celery. Returns 202 Accepted immediately. Staff only.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
- Model Source:
SoftwareCatalogImportRequest - API Source:
marketplace_software_catalogs_import_catalog
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Field | Type | Required |
|---|---|---|
name |
string | ✓ |
202 - No response body
Marketplace Software Packages
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/marketplace-software-packages/ |
List software packages |
| GET | /api/marketplace-software-packages/{uuid}/ |
Retrieve a software package |
| POST | /api/marketplace-software-packages/ |
Create a software package |
| PUT | /api/marketplace-software-packages/{uuid}/ |
Update a software package |
| PATCH | /api/marketplace-software-packages/{uuid}/ |
Partially update a software package |
| DELETE | /api/marketplace-software-packages/{uuid}/ |
Delete a software package |
List software packages
Returns a paginated list of software packages available in the catalogs. Can be filtered by catalog, offering, or various package attributes.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 | |
- Model Source:
SoftwarePackageOEnum - API Source:
marketplace_software_packages_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
catalog_name |
string | Filter packages by catalog name (case-insensitive partial match) |
catalog_uuid |
string (uuid) | Filter packages from a specific software catalog |
catalog_version |
string | Filter packages by catalog version (case-insensitive partial match) |
cpu_family |
string | Filter packages available for specific CPU family (e.g., x86_64, aarch64) |
cpu_microarchitecture |
string | Filter packages available for specific CPU microarchitecture (e.g., generic, zen2, haswell) |
description |
string | Filter packages by description (case-insensitive partial match) |
extension_name |
string | Filter packages having extensions with a specific name |
extension_type |
string | Filter packages having extensions of a specific type (e.g., 'python') |
has_version |
string | Filter packages that have a specific version |
is_extension |
boolean | Filter packages that are extensions of other packages |
name |
string | Filter packages by name (case-insensitive partial match) |
name_exact |
string | Filter packages by exact name (case-insensitive) |
o |
array | Ordering |
offering_uuid |
string (uuid) | Filter packages available for a specific offering |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
query |
string | Query packages by name, description, or version (case-insensitive partial match) |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
modified |
string (date-time) | |
catalog |
string (uri) | |
name |
string | |
description |
string | |
homepage |
string (uri) | |
categories |
any | Package categories (e.g., ['bio', 'hpc', 'build-tools']) |
licenses |
any | Software licenses (e.g., ['GPL-3.0', 'MIT']) |
maintainers |
any | Package maintainers |
is_extension |
boolean | Whether this package is an extension of another package |
parent_software |
string (uri) | Parent package for extensions (e.g., Python package within Python) |
catalog_name |
string | |
catalog_version |
string | |
catalog_type |
string | |
catalog_type_display |
string | |
version_count |
integer | |
extension_count |
integer | |
versions |
array of objects | |
versions.uuid |
string (uuid) | |
versions.version |
string | |
versions.release_date |
string (date) | |
versions.targets |
array of objects | |
versions.targets.uuid |
string (uuid) | |
versions.targets.target_type |
string | Type of target (architecture, platform, variant, etc.) |
versions.targets.target_name |
string | Target identifier (x86_64/generic, linux, variant_name, etc.) |
versions.targets.target_subtype |
string | Target subtype (microarchitecture, distribution, etc.) |
versions.targets.location |
string | Target location (CVMFS path, download URL, etc.) |
versions.targets.metadata |
any | Target-specific metadata (build options, system requirements, etc.) |
versions.module |
object (free-form) | |
versions.required_modules |
array of anys | |
versions.extensions |
array of anys | |
versions.toolchain |
object (free-form) | |
versions.toolchain_families_compatibility |
array of anys |
Retrieve a software package
Returns the details of a specific software package, including its description, homepage, and available versions.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_software_packages_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
modified |
string (date-time) | |
catalog |
string (uri) | |
name |
string | |
description |
string | |
homepage |
string (uri) | |
categories |
any | Package categories (e.g., ['bio', 'hpc', 'build-tools']) |
licenses |
any | Software licenses (e.g., ['GPL-3.0', 'MIT']) |
maintainers |
any | Package maintainers |
is_extension |
boolean | Whether this package is an extension of another package |
parent_software |
string (uri) | Parent package for extensions (e.g., Python package within Python) |
catalog_name |
string | |
catalog_version |
string | |
catalog_type |
string | |
catalog_type_display |
string | |
version_count |
integer | |
extension_count |
integer | |
versions |
array of objects | |
versions.uuid |
string (uuid) | |
versions.version |
string | |
versions.release_date |
string (date) | |
versions.targets |
array of objects | |
versions.targets.uuid |
string (uuid) | |
versions.targets.target_type |
string | Type of target (architecture, platform, variant, etc.) |
versions.targets.target_name |
string | Target identifier (x86_64/generic, linux, variant_name, etc.) |
versions.targets.target_subtype |
string | Target subtype (microarchitecture, distribution, etc.) |
versions.targets.location |
string | Target location (CVMFS path, download URL, etc.) |
versions.targets.metadata |
any | Target-specific metadata (build options, system requirements, etc.) |
versions.module |
object (free-form) | |
versions.required_modules |
array of anys | |
versions.extensions |
array of anys | |
versions.toolchain |
object (free-form) | |
versions.toolchain_families_compatibility |
array of anys |
Create a software package
Creates a new software package within a catalog. Requires staff permissions.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
SoftwarePackageRequest - API Source:
marketplace_software_packages_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Field | Type | Required | Description |
|---|---|---|---|
catalog |
string (uri) | ✓ | |
name |
string | ✓ | |
description |
string | ||
homepage |
string (uri) | ||
categories |
any | Package categories (e.g., ['bio', 'hpc', 'build-tools']) | |
licenses |
any | Software licenses (e.g., ['GPL-3.0', 'MIT']) | |
maintainers |
any | Package maintainers | |
is_extension |
boolean | Whether this package is an extension of another package | |
parent_software |
string (uri) | Parent package for extensions (e.g., Python package within Python) |
201 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
modified |
string (date-time) | |
catalog |
string (uri) | |
name |
string | |
description |
string | |
homepage |
string (uri) | |
categories |
any | Package categories (e.g., ['bio', 'hpc', 'build-tools']) |
licenses |
any | Software licenses (e.g., ['GPL-3.0', 'MIT']) |
maintainers |
any | Package maintainers |
is_extension |
boolean | Whether this package is an extension of another package |
parent_software |
string (uri) | Parent package for extensions (e.g., Python package within Python) |
catalog_name |
string | |
catalog_version |
string | |
catalog_type |
string | |
catalog_type_display |
string | |
version_count |
integer | |
extension_count |
integer | |
versions |
array of objects | |
versions.uuid |
string (uuid) | |
versions.version |
string | |
versions.release_date |
string (date) | |
versions.targets |
array of objects | |
versions.targets.uuid |
string (uuid) | |
versions.targets.target_type |
string | Type of target (architecture, platform, variant, etc.) |
versions.targets.target_name |
string | Target identifier (x86_64/generic, linux, variant_name, etc.) |
versions.targets.target_subtype |
string | Target subtype (microarchitecture, distribution, etc.) |
versions.targets.location |
string | Target location (CVMFS path, download URL, etc.) |
versions.targets.metadata |
any | Target-specific metadata (build options, system requirements, etc.) |
versions.module |
object (free-form) | |
versions.required_modules |
array of anys | |
versions.extensions |
array of anys | |
versions.toolchain |
object (free-form) | |
versions.toolchain_families_compatibility |
array of anys |
Update a software package
Updates an existing software package. Requires staff permissions.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
SoftwarePackageRequest - API Source:
marketplace_software_packages_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
catalog |
string (uri) | ✓ | |
name |
string | ✓ | |
description |
string | ||
homepage |
string (uri) | ||
categories |
any | Package categories (e.g., ['bio', 'hpc', 'build-tools']) | |
licenses |
any | Software licenses (e.g., ['GPL-3.0', 'MIT']) | |
maintainers |
any | Package maintainers | |
is_extension |
boolean | Whether this package is an extension of another package | |
parent_software |
string (uri) | Parent package for extensions (e.g., Python package within Python) |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
modified |
string (date-time) | |
catalog |
string (uri) | |
name |
string | |
description |
string | |
homepage |
string (uri) | |
categories |
any | Package categories (e.g., ['bio', 'hpc', 'build-tools']) |
licenses |
any | Software licenses (e.g., ['GPL-3.0', 'MIT']) |
maintainers |
any | Package maintainers |
is_extension |
boolean | Whether this package is an extension of another package |
parent_software |
string (uri) | Parent package for extensions (e.g., Python package within Python) |
catalog_name |
string | |
catalog_version |
string | |
catalog_type |
string | |
catalog_type_display |
string | |
version_count |
integer | |
extension_count |
integer | |
versions |
array of objects | |
versions.uuid |
string (uuid) | |
versions.version |
string | |
versions.release_date |
string (date) | |
versions.targets |
array of objects | |
versions.targets.uuid |
string (uuid) | |
versions.targets.target_type |
string | Type of target (architecture, platform, variant, etc.) |
versions.targets.target_name |
string | Target identifier (x86_64/generic, linux, variant_name, etc.) |
versions.targets.target_subtype |
string | Target subtype (microarchitecture, distribution, etc.) |
versions.targets.location |
string | Target location (CVMFS path, download URL, etc.) |
versions.targets.metadata |
any | Target-specific metadata (build options, system requirements, etc.) |
versions.module |
object (free-form) | |
versions.required_modules |
array of anys | |
versions.extensions |
array of anys | |
versions.toolchain |
object (free-form) | |
versions.toolchain_families_compatibility |
array of anys |
Partially update a software package
Partially updates an existing software package. Requires staff permissions.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedSoftwarePackageRequest - API Source:
marketplace_software_packages_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
catalog |
string (uri) | ||
name |
string | ||
description |
string | ||
homepage |
string (uri) | ||
categories |
any | Package categories (e.g., ['bio', 'hpc', 'build-tools']) | |
licenses |
any | Software licenses (e.g., ['GPL-3.0', 'MIT']) | |
maintainers |
any | Package maintainers | |
is_extension |
boolean | Whether this package is an extension of another package | |
parent_software |
string (uri) | Parent package for extensions (e.g., Python package within Python) |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
modified |
string (date-time) | |
catalog |
string (uri) | |
name |
string | |
description |
string | |
homepage |
string (uri) | |
categories |
any | Package categories (e.g., ['bio', 'hpc', 'build-tools']) |
licenses |
any | Software licenses (e.g., ['GPL-3.0', 'MIT']) |
maintainers |
any | Package maintainers |
is_extension |
boolean | Whether this package is an extension of another package |
parent_software |
string (uri) | Parent package for extensions (e.g., Python package within Python) |
catalog_name |
string | |
catalog_version |
string | |
catalog_type |
string | |
catalog_type_display |
string | |
version_count |
integer | |
extension_count |
integer | |
versions |
array of objects | |
versions.uuid |
string (uuid) | |
versions.version |
string | |
versions.release_date |
string (date) | |
versions.targets |
array of objects | |
versions.targets.uuid |
string (uuid) | |
versions.targets.target_type |
string | Type of target (architecture, platform, variant, etc.) |
versions.targets.target_name |
string | Target identifier (x86_64/generic, linux, variant_name, etc.) |
versions.targets.target_subtype |
string | Target subtype (microarchitecture, distribution, etc.) |
versions.targets.location |
string | Target location (CVMFS path, download URL, etc.) |
versions.targets.metadata |
any | Target-specific metadata (build options, system requirements, etc.) |
versions.module |
object (free-form) | |
versions.required_modules |
array of anys | |
versions.extensions |
array of anys | |
versions.toolchain |
object (free-form) | |
versions.toolchain_families_compatibility |
array of anys |
Delete a software package
Deletes a software package. Requires staff permissions.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_software_packages_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Marketplace Software Targets
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/marketplace-software-targets/ |
List software targets |
| GET | /api/marketplace-software-targets/{uuid}/ |
Retrieve a software target |
| POST | /api/marketplace-software-targets/ |
Create a software target |
| PUT | /api/marketplace-software-targets/{uuid}/ |
Update a software target |
| PATCH | /api/marketplace-software-targets/{uuid}/ |
Partially update a software target |
| DELETE | /api/marketplace-software-targets/{uuid}/ |
Delete a software target |
List software targets
Returns a paginated list of software targets, which represent specific builds of a software version for a given CPU architecture.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 | |
- Model Source:
SoftwareTargetOEnum - API Source:
marketplace_software_targets_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
catalog_uuid |
string (uuid) | |
cpu_family |
string | |
cpu_microarchitecture |
string | |
o |
array | Ordering |
offering_uuid |
string (uuid) | |
package_uuid |
string (uuid) | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
path |
string | |
version_uuid |
string (uuid) |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
modified |
string (date-time) | |
target_type |
string | Type of target (architecture, platform, variant, etc.) |
target_name |
string | Target identifier (x86_64/generic, linux, variant_name, etc.) |
target_subtype |
string | Target subtype (microarchitecture, distribution, etc.) |
location |
string | Target location (CVMFS path, download URL, etc.) |
metadata |
any | Target-specific metadata (build options, system requirements, etc.) |
Retrieve a software target
Returns the details of a specific software target, including its CPU family, microarchitecture, and path.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_software_targets_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
modified |
string (date-time) | |
target_type |
string | Type of target (architecture, platform, variant, etc.) |
target_name |
string | Target identifier (x86_64/generic, linux, variant_name, etc.) |
target_subtype |
string | Target subtype (microarchitecture, distribution, etc.) |
location |
string | Target location (CVMFS path, download URL, etc.) |
metadata |
any | Target-specific metadata (build options, system requirements, etc.) |
Create a software target
Creates a new target for a software version. Requires staff permissions.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
- API Source:
marketplace_software_targets_create
1 2 3 4 5 6 7 8 9 10 | |
201 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
modified |
string (date-time) | |
target_type |
string | Type of target (architecture, platform, variant, etc.) |
target_name |
string | Target identifier (x86_64/generic, linux, variant_name, etc.) |
target_subtype |
string | Target subtype (microarchitecture, distribution, etc.) |
location |
string | Target location (CVMFS path, download URL, etc.) |
metadata |
any | Target-specific metadata (build options, system requirements, etc.) |
Update a software target
Updates an existing software target. Requires staff permissions.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_software_targets_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
modified |
string (date-time) | |
target_type |
string | Type of target (architecture, platform, variant, etc.) |
target_name |
string | Target identifier (x86_64/generic, linux, variant_name, etc.) |
target_subtype |
string | Target subtype (microarchitecture, distribution, etc.) |
location |
string | Target location (CVMFS path, download URL, etc.) |
metadata |
any | Target-specific metadata (build options, system requirements, etc.) |
Partially update a software target
Partially updates an existing software target. Requires staff permissions.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_software_targets_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
modified |
string (date-time) | |
target_type |
string | Type of target (architecture, platform, variant, etc.) |
target_name |
string | Target identifier (x86_64/generic, linux, variant_name, etc.) |
target_subtype |
string | Target subtype (microarchitecture, distribution, etc.) |
location |
string | Target location (CVMFS path, download URL, etc.) |
metadata |
any | Target-specific metadata (build options, system requirements, etc.) |
Delete a software target
Deletes a software target. Requires staff permissions.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_software_targets_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Marketplace Software Versions
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/marketplace-software-versions/ |
List software versions |
| GET | /api/marketplace-software-versions/{uuid}/ |
Retrieve a software version |
| POST | /api/marketplace-software-versions/ |
Create a software version |
| PUT | /api/marketplace-software-versions/{uuid}/ |
Update a software version |
| PATCH | /api/marketplace-software-versions/{uuid}/ |
Partially update a software version |
| DELETE | /api/marketplace-software-versions/{uuid}/ |
Delete a software version |
List software versions
Returns a paginated list of software versions. Can be filtered by package, catalog, offering, or CPU architecture.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 | |
- Model Source:
SoftwareVersionOEnum - API Source:
marketplace_software_versions_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
catalog_uuid |
string (uuid) | |
cpu_family |
string | |
cpu_microarchitecture |
string | |
o |
array | Ordering |
offering_uuid |
string (uuid) | |
package_name |
string | |
package_uuid |
string (uuid) | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
version |
string |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
modified |
string (date-time) | |
version |
string | |
release_date |
string (date) | |
dependencies |
any | Package dependencies (format varies by catalog type) |
metadata |
any | Version-specific metadata (toolchains, build info, modules, etc.) |
package_name |
string | |
catalog_type |
string | |
target_count |
integer | |
module |
object (free-form) | |
required_modules |
array of anys | |
extensions |
array of anys | |
toolchain |
object (free-form) | |
toolchain_families_compatibility |
array of anys |
Retrieve a software version
Returns the details of a specific software version, including its release date and target count.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_software_versions_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
modified |
string (date-time) | |
version |
string | |
release_date |
string (date) | |
dependencies |
any | Package dependencies (format varies by catalog type) |
metadata |
any | Version-specific metadata (toolchains, build info, modules, etc.) |
package_name |
string | |
catalog_type |
string | |
target_count |
integer | |
module |
object (free-form) | |
required_modules |
array of anys | |
extensions |
array of anys | |
toolchain |
object (free-form) | |
toolchain_families_compatibility |
array of anys |
Create a software version
Creates a new version for a software package. Requires staff permissions.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
- API Source:
marketplace_software_versions_create
1 2 3 4 5 6 7 8 9 10 | |
201 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
modified |
string (date-time) | |
version |
string | |
release_date |
string (date) | |
dependencies |
any | Package dependencies (format varies by catalog type) |
metadata |
any | Version-specific metadata (toolchains, build info, modules, etc.) |
package_name |
string | |
catalog_type |
string | |
target_count |
integer | |
module |
object (free-form) | |
required_modules |
array of anys | |
extensions |
array of anys | |
toolchain |
object (free-form) | |
toolchain_families_compatibility |
array of anys |
Update a software version
Updates an existing software version. Requires staff permissions.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_software_versions_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
modified |
string (date-time) | |
version |
string | |
release_date |
string (date) | |
dependencies |
any | Package dependencies (format varies by catalog type) |
metadata |
any | Version-specific metadata (toolchains, build info, modules, etc.) |
package_name |
string | |
catalog_type |
string | |
target_count |
integer | |
module |
object (free-form) | |
required_modules |
array of anys | |
extensions |
array of anys | |
toolchain |
object (free-form) | |
toolchain_families_compatibility |
array of anys |
Partially update a software version
Partially updates an existing software version. Requires staff permissions.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_software_versions_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
modified |
string (date-time) | |
version |
string | |
release_date |
string (date) | |
dependencies |
any | Package dependencies (format varies by catalog type) |
metadata |
any | Version-specific metadata (toolchains, build info, modules, etc.) |
package_name |
string | |
catalog_type |
string | |
target_count |
integer | |
module |
object (free-form) | |
required_modules |
array of anys | |
extensions |
array of anys | |
toolchain |
object (free-form) | |
toolchain_families_compatibility |
array of anys |
Delete a software version
Deletes a software version. Requires staff permissions.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_software_versions_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Usage and stats
Marketplace Category Component Usages
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/marketplace-category-component-usages/ |
List aggregated category component usages |
| GET | /api/marketplace-category-component-usages/{id}/ |
Retrieve an aggregated category component usage record |
List aggregated category component usages
1 2 3 4 5 6 | |
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 | |
- Model Source:
CategoryComponentUsageFieldEnum - API Source:
marketplace_category_component_usages_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
date_after |
string (date) | Date after or equal to |
date_before |
string (date) | Date before or equal to |
field |
array | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
scope |
string (uri) | Filter by scope URL. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
name |
string | Display name for the measured unit, for example, Floating IP. |
type |
string | Unique internal name of the measured unit, for example floating_ip. |
measured_unit |
string | Unit of measurement, for example, GB. |
category_title |
string | |
category_uuid |
string (uuid) | |
date |
string (date) | |
reported_usage |
integer (int64) | |
fixed_usage |
integer (int64) | |
scope |
string |
Retrieve an aggregated category component usage record
Returns the details of a single aggregated usage record for a category component, identified by its database ID.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
CategoryComponentUsageFieldEnum - API Source:
marketplace_category_component_usages_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required | Description |
|---|---|---|---|
id |
integer | ✓ | A unique integer value identifying this category component usage. |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type | Description |
|---|---|---|
name |
string | Display name for the measured unit, for example, Floating IP. |
type |
string | Unique internal name of the measured unit, for example floating_ip. |
measured_unit |
string | Unit of measurement, for example, GB. |
category_title |
string | |
category_uuid |
string (uuid) | |
date |
string (date) | |
reported_usage |
integer (int64) | |
fixed_usage |
integer (int64) | |
scope |
string |
Marketplace Component Usages
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/marketplace-component-usages/ |
List component usage records |
| GET | /api/marketplace-component-usages/{uuid}/ |
Retrieve a component usage record |
| Other Actions | ||
| POST | /api/marketplace-component-usages/set_usage/ |
Set component usage for a resource |
| POST | /api/marketplace-component-usages/{uuid}/set_user_usage/ |
Set user-specific component usage |
| POST | /api/marketplace-component-usages/{uuid}/set_user_usages/ |
Bulk set user-specific component usages |
Core CRUD
List component usage records
Returns a paginated list of component usage records for resources. This data is used for billing and usage tracking.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- Model Source:
ComponentUsageFieldEnum - Model Source:
ComponentUsageOEnum - API Source:
marketplace_component_usages_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
billing_period |
string (date) | |
billing_period_month |
number | Billing period month |
billing_period_year |
number | Billing period year |
customer_uuid |
string (uuid) | Customer UUID |
date_after |
string (date) | Date after or equal to |
date_before |
string (date) | Date before or equal to |
field |
array | |
o |
array | Ordering |
offering_uuid |
string (uuid) | Offering UUID |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
project_uuid |
string (uuid) | Project UUID |
resource |
string (uri) | Resource URL |
resource_uuid |
string (uuid) | Resource UUID |
type |
string | Component type |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
created |
string (date-time) | |
description |
string | |
type |
string | Unique internal name of the measured unit, for example floating_ip. |
name |
string | Display name for the measured unit, for example, Floating IP. |
measured_unit |
string | Unit of measurement, for example, GB. |
usage |
integer | |
date |
string (date-time) | |
recurring |
boolean | Reported value is reused every month until changed. |
resource_name |
string | |
resource_uuid |
string (uuid) | |
offering_name |
string | |
offering_uuid |
string (uuid) | |
project_name |
string | |
project_uuid |
string | |
customer_name |
string | |
customer_uuid |
string | |
billing_period |
string (date) | |
modified_by |
integer |
Retrieve a component usage record
Returns the details of a specific component usage record.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
ComponentUsageFieldEnum - API Source:
marketplace_component_usages_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
created |
string (date-time) | |
description |
string | |
type |
string | Unique internal name of the measured unit, for example floating_ip. |
name |
string | Display name for the measured unit, for example, Floating IP. |
measured_unit |
string | Unit of measurement, for example, GB. |
usage |
integer | |
date |
string (date-time) | |
recurring |
boolean | Reported value is reused every month until changed. |
resource_name |
string | |
resource_uuid |
string (uuid) | |
offering_name |
string | |
offering_uuid |
string (uuid) | |
project_name |
string | |
project_uuid |
string | |
customer_name |
string | |
customer_uuid |
string | |
billing_period |
string (date) | |
modified_by |
integer |
Other Actions
Set component usage for a resource
1 2 3 4 5 6 | |
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
- Model Source:
ComponentUsageCreateRequest - API Source:
marketplace_component_usages_set_usage
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Field | Type | Required | Description |
|---|---|---|---|
usages |
array of objects | ✓ | List of component usage items to report |
usages.type |
string | ✓ | Type of the component |
usages.amount |
string (decimal) | ✓ | Usage amount |
usages.description |
string | Optional description of usage | |
usages.recurring |
boolean | Whether this usage is recurring Constraints: default: False |
|
plan_period |
string (uuid) | UUID of the specific resource plan period for usage reporting | |
resource |
string (uuid) | UUID of the resource for usage reporting (required if plan_period not provided) | |
date |
string (date-time) | Date for usage reporting (staff and service providers for limit-based components). If not provided, current date is used. |
201 - No response body
Set user-specific component usage
1 2 3 4 5 | |
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
ComponentUserUsageCreateRequest - API Source:
marketplace_component_usages_set_user_usage
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
usage |
string (decimal) | ||
username |
string | ✓ | |
user |
string (uri) | ||
date |
string (date-time) | Date for usage reporting (staff and service providers for limit-based components). If not provided, current date is used. |
201 - No response body
Bulk set user-specific component usages
1 2 3 4 5 6 | |
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
ComponentUserUsageBulkCreateRequest - API Source:
marketplace_component_usages_set_user_usages
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
usages |
array of objects | ✓ | |
usages.usage |
string (decimal) | ||
usages.username |
string | ✓ | |
usages.user |
string (uri) | ||
usages.date |
string (date-time) | Date for usage reporting (staff and service providers for limit-based components). If not provided, current date is used. |
201 - No response body
Component User Usage Limits
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/component-user-usage-limits/ |
List component usage limits for users |
| GET | /api/component-user-usage-limits/{uuid}/ |
Retrieve a component usage limit |
| POST | /api/component-user-usage-limits/ |
Create a component usage limit for a user |
| PUT | /api/component-user-usage-limits/{uuid}/ |
Update a component usage limit |
| PATCH | /api/component-user-usage-limits/{uuid}/ |
Partially update a component usage limit |
| DELETE | /api/component-user-usage-limits/{uuid}/ |
Delete a component usage limit |
List component usage limits for users
Returns a paginated list of usage limits set for specific users on resource components.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
component_user_usage_limits_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
component_type |
string | Component type |
offering_uuid |
string (uuid) | Offering UUID |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
resource |
string (uri) | Resource URL |
resource_uuid |
string (uuid) | Resource UUID |
username |
string | Username |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
resource |
string (uri) | |
component |
string (uuid) | |
component_type |
string | Unique internal name of the measured unit, for example floating_ip. |
user |
string (uri) | |
limit |
string (decimal) |
Retrieve a component usage limit
Returns the details of a specific user's usage limit for a component.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
component_user_usage_limits_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
resource |
string (uri) | |
component |
string (uuid) | |
component_type |
string | Unique internal name of the measured unit, for example floating_ip. |
user |
string (uri) | |
limit |
string (decimal) |
Create a component usage limit for a user
Sets a usage limit for a specific user on a resource's component. This is only applicable for offerings that support per-user consumption limitation.
1 2 3 4 5 6 7 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
ComponentUserUsageLimitRequest - API Source:
component_user_usage_limits_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
| Field | Type | Required |
|---|---|---|
resource |
string (uri) | ✓ |
component |
string (uuid) | ✓ |
user |
string (uri) | ✓ |
limit |
string (decimal) |
201 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
resource |
string (uri) | |
component |
string (uuid) | |
component_type |
string | Unique internal name of the measured unit, for example floating_ip. |
user |
string (uri) | |
limit |
string (decimal) |
Update a component usage limit
Updates an existing usage limit for a user on a component.
1 2 3 4 5 6 7 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | |
- Model Source:
ComponentUserUsageLimitRequest - API Source:
component_user_usage_limits_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
resource |
string (uri) | ✓ |
component |
string (uuid) | ✓ |
user |
string (uri) | ✓ |
limit |
string (decimal) |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
resource |
string (uri) | |
component |
string (uuid) | |
component_type |
string | Unique internal name of the measured unit, for example floating_ip. |
user |
string (uri) | |
limit |
string (decimal) |
Partially update a component usage limit
Partially updates an existing usage limit for a user on a component.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedComponentUserUsageLimitRequest - API Source:
component_user_usage_limits_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
resource |
string (uri) | |
component |
string (uuid) | |
user |
string (uri) | |
limit |
string (decimal) |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
resource |
string (uri) | |
component |
string (uuid) | |
component_type |
string | Unique internal name of the measured unit, for example floating_ip. |
user |
string (uri) | |
limit |
string (decimal) |
Delete a component usage limit
Removes a usage limit for a user on a component.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
component_user_usage_limits_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Marketplace Component User Usages
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/marketplace-component-user-usages/ |
List user-specific component usages |
| GET | /api/marketplace-component-user-usages/{uuid}/ |
Retrieve a user-specific component usage record |
List user-specific component usages
1 2 3 | |
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- Model Source:
ComponentUserUsageFieldEnum - Model Source:
ComponentUserUsageOEnum - API Source:
marketplace_component_user_usages_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
billing_period_month |
number | Billing period month |
billing_period_year |
number | Billing period year |
component_usage__billing_period |
string (date) | |
customer_uuid |
string (uuid) | Customer UUID |
date_after |
string (date) | Date after or equal to |
date_before |
string (date) | Date before or equal .google/docsto |
field |
array | |
o |
array | Ordering |
offering_uuid |
string (uuid) | Offering UUID |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
project_uuid |
string (uuid) | Project UUID |
resource |
string (uri) | Resource URL |
resource_uuid |
string (uuid) | Resource UUID |
type |
string | Component type |
username |
string | Username contains |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
user |
string (uri) | |
username |
string | |
component_usage |
string (uri) | |
usage |
integer | |
measured_unit |
string | Unit of measurement, for example, GB. |
description |
string | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
resource_name |
string | |
resource_uuid |
string (uuid) | |
offering_name |
string | |
offering_uuid |
string (uuid) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer_name |
string | |
customer_uuid |
string (uuid) | |
component_type |
string | Unique internal name of the measured unit, for example floating_ip. |
date |
string (date-time) | |
billing_period |
string (date) |
Retrieve a user-specific component usage record
Returns the details of a single user-specific component usage record.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
ComponentUserUsageFieldEnum - API Source:
marketplace_component_user_usages_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
user |
string (uri) | |
username |
string | |
component_usage |
string (uri) | |
usage |
integer | |
measured_unit |
string | Unit of measurement, for example, GB. |
description |
string | |
created |
string (date-time) | |
modified |
string (date-time) | |
backend_id |
string | |
resource_name |
string | |
resource_uuid |
string (uuid) | |
offering_name |
string | |
offering_uuid |
string (uuid) | |
project_name |
string | |
project_uuid |
string (uuid) | |
customer_name |
string | |
customer_uuid |
string (uuid) | |
component_type |
string | Unique internal name of the measured unit, for example floating_ip. |
date |
string (date-time) | |
billing_period |
string (date) |
Marketplace Stats
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/marketplace-stats/aggregated_usage_trends/ |
Return aggregated usage trends per month |
| GET | /api/marketplace-stats/component_usages/ |
Return component usages for current month |
| GET | /api/marketplace-stats/component_usages_per_month/ |
Return component usages per month |
| GET | /api/marketplace-stats/component_usages_per_project/ |
Return component usages per project |
| GET | /api/marketplace-stats/count_active_resources_grouped_by_offering_country/ |
Count active resources grouped by offering country |
| GET | /api/marketplace-stats/count_active_resources_grouped_by_offering/ |
Count active resources grouped by offering |
| GET | /api/marketplace-stats/count_active_resources_grouped_by_organization_group/ |
Count active resources grouped by organization group |
| GET | /api/marketplace-stats/count_projects_grouped_by_provider_and_industry_flag/ |
Count projects grouped by provider and industry flag |
| GET | /api/marketplace-stats/count_projects_grouped_by_provider_and_oecd/ |
Count projects grouped by provider and OECD code |
| GET | /api/marketplace-stats/count_projects_of_service_providers_grouped_by_oecd/ |
Count projects of service providers grouped by OECD |
| GET | /api/marketplace-stats/count_projects_of_service_providers/ |
Count projects of service providers |
| GET | /api/marketplace-stats/count_unique_users_connected_with_active_resources_of_service_provider/ |
Count unique users connected with active resources of service provider |
| GET | /api/marketplace-stats/count_users_of_service_providers/ |
Count users of service providers |
| GET | /api/marketplace-stats/customer_member_count/ |
Return count of customer members |
| GET | /api/marketplace-stats/customer_member_summary/ |
Return summary statistics for customer members |
| GET | /api/marketplace-stats/offering_costs_summary/ |
Return summary statistics for offering costs |
| GET | /api/marketplace-stats/offerings_counter_stats/ |
Offerings counter stats |
| GET | /api/marketplace-stats/order_stats/ |
Order stats |
| GET | /api/marketplace-stats/organization_project_count/ |
Return project count per organization |
| GET | /api/marketplace-stats/organization_resource_count/ |
Return resource count per organization |
| GET | /api/marketplace-stats/project_classification_summary/ |
Return summary statistics for project classification |
| GET | /api/marketplace-stats/projects_limits_grouped_by_industry_flag/ |
Group project limits by industry flag |
| GET | /api/marketplace-stats/projects_limits_grouped_by_oecd/ |
Group project limits by OECD code |
| GET | /api/marketplace-stats/projects_usages_grouped_by_industry_flag/ |
Group project usages by industry flag |
| GET | /api/marketplace-stats/projects_usages_grouped_by_oecd/ |
Group project usages by OECD code |
| GET | /api/marketplace-stats/provider_customers/ |
Return customer statistics for a service provider |
| GET | /api/marketplace-stats/provider_offerings/ |
Return offering performance statistics for a service provider |
| GET | /api/marketplace-stats/provider_resources/ |
Return resource statistics for a service provider |
| GET | /api/marketplace-stats/resource_provisioning_stats/ |
Get resource provisioning statistics |
| GET | /api/marketplace-stats/resource_usage_by_creator_affiliation/ |
Return resource usage grouped by creator's affiliation |
| GET | /api/marketplace-stats/resource_usage_by_customer/ |
Return resource usage statistics grouped by customer |
| GET | /api/marketplace-stats/resource_usage_by_organization_type/ |
Return component usages grouped by project members' organization type |
| GET | /api/marketplace-stats/resources_geography_summary/ |
Return summary statistics for resource geographic distribution |
| GET | /api/marketplace-stats/resources_limits/ |
Return resources limits per offering |
| GET | /api/marketplace-stats/resources_missing_usage/ |
Resources missing usage |
| GET | /api/marketplace-stats/total_cost_of_active_resources_per_offering/ |
Total cost of active resources per offering |
| GET | /api/marketplace-stats/user_affiliation_count/ |
Return user count grouped by affiliation |
| GET | /api/marketplace-stats/user_auth_method_count/ |
Return user count grouped by authentication method |
| GET | /api/marketplace-stats/user_identity_source_count/ |
Return user count grouped by identity source |
| GET | /api/marketplace-stats/user_job_title_count/ |
Return user count grouped by job title |
| GET | /api/marketplace-stats/user_organization_count/ |
Return user count grouped by organization |
| GET | /api/marketplace-stats/user_organization_type_count/ |
Return user count grouped by organization type (SCHAC URN) |
Return aggregated usage trends per month
Return aggregated usage trends per month.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
marketplace_stats_aggregated_usage_trends_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
period |
string | Period in YYYY-MM format |
year |
integer | Year |
month |
integer | Month (1-12) |
total_usage |
string (decimal) | Total usage across all components |
resource_count |
integer | Number of distinct resources with usage |
component_count |
integer | Number of component usage records |
Return component usages for current month
Return component usages for current month.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
marketplace_stats_component_usages_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
usage |
string (decimal) | Total usage amount |
offering_uuid |
string (uuid) | UUID of the offering |
component_type |
string | Type of the component |
offering_country |
string | Country of the offering |
organization_group_name |
string | Name of the organization group |
organization_group_uuid |
string | UUID of the organization group |
Return component usages per month
Return component usages per month.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
usage |
string (decimal) | Total usage amount |
offering_uuid |
string (uuid) | UUID of the offering |
component_type |
string | Type of the component |
offering_country |
string | Country of the offering |
organization_group_name |
string | Name of the organization group |
organization_group_uuid |
string | UUID of the organization group |
month |
integer | Month of the billing period |
year |
integer | Year of the billing period |
Return component usages per project
Return component usages per project.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
project_uuid |
string (uuid) | UUID of the project |
component_type |
string | Type of the component |
usage |
integer | Total usage for the component |
Count active resources grouped by offering country
Count active resources grouped by offering country.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
country |
string | Country code of the offering |
count |
integer | Number of offerings in this country |
Count active resources grouped by offering
Count active resources grouped by offering.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
count |
integer | Number of resources for the offering |
name |
string | Name of the offering |
uuid |
string | UUID of the offering |
country |
string | Country of the offering |
Count active resources grouped by organization group
Count active resources grouped by organization group.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
name |
string | Name from the record |
uuid |
string | UUID from the record |
count |
integer | Count value from the record |
Count projects grouped by provider and industry flag
Count projects grouped by provider and industry flag
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
name |
string | Name from the record |
uuid |
string | UUID from the record |
count |
integer | Count value from the record |
abbreviation |
string | Customer abbreviation from the record |
is_industry |
string | Industry classification flag |
Count projects grouped by provider and OECD code
Count projects grouped by provider and OECD code
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
name |
string | Name from the record |
uuid |
string | UUID from the record |
count |
integer | Count value from the record |
abbreviation |
string | Customer abbreviation from the record |
oecd |
string |
Count projects of service providers grouped by OECD
Count projects of service providers grouped by OECD.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
service_provider_uuid |
string (uuid) | UUID of the service provider |
customer_uuid |
string (uuid) | UUID of the customer |
customer_name |
string | Name of the customer |
customer_organization_group_uuid |
string | UUID of the customer's organization group |
customer_organization_group_name |
string | Name of the customer's organization group |
count |
integer | Count value |
oecd_fos_2007_name |
string |
Count projects of service providers
Count projects of service providers.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
service_provider_uuid |
string (uuid) | UUID of the service provider |
customer_uuid |
string (uuid) | UUID of the customer |
customer_name |
string | Name of the customer |
customer_organization_group_uuid |
string | UUID of the customer's organization group |
customer_organization_group_name |
string | Name of the customer's organization group |
count |
integer | Count value |
Count unique users connected with active resources of service provider
Count unique users connected with active resources of service provider.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
customer_uuid |
string (uuid) | UUID of the customer |
customer_name |
string | Name of the customer |
count_users |
integer | Number of unique users |
Count users of service providers
Count users of service providers.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
service_provider_uuid |
string (uuid) | UUID of the service provider |
customer_uuid |
string (uuid) | UUID of the customer |
customer_name |
string | Name of the customer |
customer_organization_group_uuid |
string | UUID of the customer's organization group |
customer_organization_group_name |
string | Name of the customer's organization group |
count |
integer | Count value |
Return count of customer members
Return count of customer members.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
marketplace_stats_customer_member_count_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | UUID of the customer |
name |
string | Name of the customer |
abbreviation |
string | Abbreviation of the customer |
count |
integer | Number of members |
has_resources |
boolean | Whether the customer has resources |
Return summary statistics for customer members
Return summary statistics for customer members.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
1 2 3 4 5 6 7 8 9 10 | |
200 -
| Field | Type | Description |
|---|---|---|
total_organizations |
integer | Total number of organizations |
total_members |
integer | Total number of members across all organizations |
organizations_with_resources |
integer | Number of organizations with active resources |
average_members_per_org |
integer | Average number of members per organization |
Return summary statistics for offering costs
Return summary statistics for offering costs.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
1 2 3 4 5 6 7 8 9 10 | |
200 -
| Field | Type | Description |
|---|---|---|
total_cost |
string (decimal) | Total cost of all active resources across all offerings |
offering_count |
integer | Number of offerings with active resources |
average_cost |
string (decimal) | Average cost per offering |
Offerings counter stats
Retrieve statistics about the number of offerings, grouped by category and service provider.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
marketplace_stats_offerings_counter_stats_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
category_uuid |
string (uuid) | UUID of the category |
category_title |
string | Title of the category |
service_provider_name |
string | Name of the service provider |
service_provider_uuid |
string (uuid) | UUID of the service provider |
count |
integer | Number of offerings |
Order stats
Return comprehensive order statistics including daily breakdown, state/type aggregations, and summary stats.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
- API Source:
marketplace_stats_order_stats_retrieve
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
customer_uuid |
string | Filter by customer UUID. |
end |
string | End date in YYYY-MM-DD format. Defaults to today. |
provider_uuid |
string | Filter by service provider UUID. |
start |
string | Start date in YYYY-MM-DD format. Defaults to 30 days ago. |
200 -
| Field | Type | Description |
|---|---|---|
summary |
any | Summary statistics |
by_state |
object (free-form) | Total order counts grouped by state |
by_type |
object (free-form) | Total order counts grouped by type |
daily |
array of objects | Daily breakdown |
daily.date |
string (date) | Date of the statistics |
daily.total |
integer | Total number of orders |
daily.total_cost |
string (decimal) | Total cost of orders |
daily.revenue |
string (decimal) | Revenue from create/update orders |
daily.by_state |
object (free-form) | Order counts grouped by state |
daily.by_type |
object (free-form) | Order counts grouped by type |
Return project count per organization
Return project count per organization.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
name |
string | Name from the record |
uuid |
string | UUID from the record |
count |
integer | Count value from the record |
abbreviation |
string | Customer abbreviation from the record |
Return resource count per organization
Return resource count per organization.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
name |
string | Name from the record |
uuid |
string | UUID from the record |
count |
integer | Count value from the record |
abbreviation |
string | Customer abbreviation from the record |
Return summary statistics for project classification
Return summary statistics for project classification.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
1 2 3 4 5 6 7 8 9 10 | |
200 -
| Field | Type | Description |
|---|---|---|
total_projects |
integer | Total number of projects |
academic_projects |
integer | Number of academic projects (industry_flag=False) |
industry_projects |
integer | Number of industry projects (industry_flag=True) |
Group project limits by industry flag
Group project limits by industry flag.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
1 2 3 4 5 6 7 8 9 10 | |
200 -
| Field | Type | Description |
|---|---|---|
limits |
object (free-form) | Nested dictionary of resource limits by category and component type |
Group project limits by OECD code
Group project limits by OECD code.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
1 2 3 4 5 6 7 8 9 10 | |
200 -
| Field | Type | Description |
|---|---|---|
limits |
object (free-form) | Nested dictionary of resource limits by category and component type |
Group project usages by industry flag
Group project usages by industry flag.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
1 2 3 4 5 6 7 8 9 10 | |
200 -
| Field | Type | Description |
|---|---|---|
usages |
object (free-form) | Nested dictionary of usage values by category and component type |
Group project usages by OECD code
Group project usages by OECD code.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
1 2 3 4 5 6 7 8 9 10 | |
200 -
| Field | Type | Description |
|---|---|---|
usages |
object (free-form) | Nested dictionary of usage values by category and component type |
Return customer statistics for a service provider
Return customer statistics for a service provider.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_stats_provider_customers_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required | Description |
|---|---|---|---|
provider_uuid |
string | ✓ | Service provider UUID. |
200 -
| Field | Type | Description |
|---|---|---|
total |
integer | Total number of customers |
new_this_month |
integer | New customers this month |
top_by_revenue |
array of objects | Top customers by revenue |
top_by_resources |
array of objects | Top customers by resource count |
monthly |
array of objects | Monthly customer counts |
Return offering performance statistics for a service provider
Return offering performance statistics for a service provider.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_stats_provider_offerings_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required | Description |
|---|---|---|---|
provider_uuid |
string | ✓ | Service provider UUID. |
200 -
| Field | Type | Description |
|---|---|---|
offerings |
array of objects | Offering statistics including resources, revenue, and utilization |
Return resource statistics for a service provider
Return resource statistics for a service provider.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
marketplace_stats_provider_resources_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required | Description |
|---|---|---|---|
provider_uuid |
string | ✓ | Service provider UUID. |
200 -
| Field | Type | Description |
|---|---|---|
total |
integer | Total number of resources |
by_state |
object (free-form) | Resource counts grouped by state |
by_offering |
array of objects | Resource counts grouped by offering |
monthly |
array of objects | Monthly resource counts |
Get resource provisioning statistics
Get resource provisioning statistics.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
last_minutes |
integer | Filter by last N minutes. Default is 60. |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
offering_uuid |
string (uuid) | UUID of the offering |
offering_name |
string | Name of the offering |
service_provider_uuid |
string (uuid) | UUID of the service provider |
service_provider_name |
string | Name of the service provider |
provisioning_count |
integer | Total finished provisioning attempts (DONE + ERRED) |
provisioning_success_count |
integer | Total successful provisioning attempts (DONE) |
provisioning_error_count |
integer | Total failed provisioning attempts (ERRED) |
provisioning_in_progress_count |
integer | Total currently in-progress provisioning attempts |
provisioning_success_rate |
number (double) | Rate of successful provisioning (0.0 to 1.0) |
avg_provisioning_duration |
number (double) | Average duration in seconds from Executing to Terminal state |
avg_pending_duration |
number (double) | Average duration in seconds from Creation to Executing state |
Return resource usage grouped by creator's affiliation
Return resource usage grouped by creator's affiliation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
affiliation |
string | User affiliation value |
component_type |
string | Component type |
total_usage |
string (decimal) | Total usage |
total_cost |
string (decimal) | Total cost |
resource_count |
integer | Number of resources |
Return resource usage statistics grouped by customer
Return resource usage statistics grouped by customer.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
customer_uuid |
string (uuid) | UUID of the customer |
customer_name |
string | Name of the customer |
customer_abbreviation |
string | Abbreviation of the customer |
resources_ok |
integer | Number of OK resources |
resources_erred |
integer | Number of erred resources |
resources_total |
integer | Total number of active resources |
total_cost |
string (decimal) | Total cost of resources |
usages |
object (free-form) | Component usages keyed by component type |
limits |
object (free-form) | Resource limits keyed by limit name |
Return component usages grouped by project members' organization type
Return component usages grouped by project members' organization type.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
organization_type |
string | SCHAC organization type URN |
component_type |
string | Component type (e.g., cpu, gpu) |
usage |
string (decimal) | Total usage for this component |
resource_count |
integer | Number of resources |
Return summary statistics for resource geographic distribution
Return summary statistics for resource geographic distribution.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
1 2 3 4 5 6 7 8 9 10 | |
200 -
| Field | Type | Description |
|---|---|---|
total_resources |
integer | Total number of active resources |
countries_count |
integer | Number of countries with active resources |
org_groups_count |
integer | Number of organization groups with active resources |
offerings_count |
integer | Number of offerings with active resources |
Return resources limits per offering
Return resources limits per offering.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
marketplace_stats_resources_limits_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
offering_uuid |
string (uuid) | UUID of the offering |
name |
string | Name of the limit |
value |
integer | Limit value |
offering_country |
string | Country of the offering |
organization_group_name |
string | Name of the organization group |
organization_group_uuid |
string | UUID of the organization group |
Resources missing usage
Return usage-based resources with no usage reported in the specified billing period.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
marketplace_stats_resources_missing_usage_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
billing_period |
string | Billing period in YYYY-MM format. Defaults to current month. |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
provider_uuid |
string | Filter by service provider UUID. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | UUID of the resource |
name |
string | Name of the resource |
state |
string | Current state of the resource |
created |
string (date-time) | Creation date of the resource |
offering_name |
string | Name of the offering |
offering_uuid |
string (uuid) | UUID of the offering |
provider_name |
string | Name of the service provider |
provider_uuid |
string (uuid) | UUID of the service provider |
customer_name |
string | Name of the customer organization |
customer_uuid |
string (uuid) | UUID of the customer organization |
project_name |
string | Name of the project |
project_uuid |
string (uuid) | UUID of the project |
last_usage_date |
string (date-time) | Date of the last usage report |
days_since_last_report |
integer | Number of days since last usage report |
Total cost of active resources per offering
Total cost of active resources per offering.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
offering_uuid |
string (uuid) | UUID of the offering |
offering_name |
string | Name of the offering |
cost |
number (double) | Total cost for the offering |
Return user count grouped by affiliation
Return user count grouped by affiliation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
marketplace_stats_user_affiliation_count_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
affiliation |
string | Affiliation name |
count |
integer | Number of users |
Return user count grouped by authentication method
Return user count grouped by authentication method.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
marketplace_stats_user_auth_method_count_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
method |
string | Authentication method |
count |
integer | Number of users |
Return user count grouped by identity source
Return user count grouped by identity source.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
identity_source |
string | Identity source |
count |
integer | Number of users |
Return user count grouped by job title
Return user count grouped by job title.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
marketplace_stats_user_job_title_count_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
job_title |
string | Job title |
count |
integer | Number of users |
Return user count grouped by organization
Return user count grouped by organization.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
marketplace_stats_user_organization_count_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
organization |
string | Organization name |
count |
integer | Number of users |
Return user count grouped by organization type (SCHAC URN)
Return user count grouped by organization type (SCHAC URN).
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
organization_type |
string | Organization type (SCHAC URN) |
count |
integer | Number of users |
Proposals and calls
Calls for proposals
Call Assignment Configurations
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/call-assignment-configurations/ |
List Call Assignment Configurations |
| GET | /api/call-assignment-configurations/{uuid}/ |
Retrieve |
| POST | /api/call-assignment-configurations/ |
Create |
| PUT | /api/call-assignment-configurations/{uuid}/ |
Update |
| PATCH | /api/call-assignment-configurations/{uuid}/ |
Partial Update |
| DELETE | /api/call-assignment-configurations/{uuid}/ |
Delete |
List Call Assignment Configurations
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
call_assignment_configurations_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
call |
string (uri) | |
call_uuid |
string (uuid) | |
call_name |
string | |
auto_reassign_on_decline |
boolean | Automatically assign next-best reviewer when someone declines. If False, manager must manually approve reassignments. |
max_auto_reassign_attempts |
integer | Maximum automatic reassignment attempts before requiring manual intervention. |
assignment_expiration_days |
integer | Days until assignment invitation expires if not responded to. |
send_reminder_before_expiry_days |
integer | Days before expiry to send reminder notification. |
created |
string (date-time) | |
modified |
string (date-time) |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
call_assignment_configurations_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
call |
string (uri) | |
call_uuid |
string (uuid) | |
call_name |
string | |
auto_reassign_on_decline |
boolean | Automatically assign next-best reviewer when someone declines. If False, manager must manually approve reassignments. |
max_auto_reassign_attempts |
integer | Maximum automatic reassignment attempts before requiring manual intervention. |
assignment_expiration_days |
integer | Days until assignment invitation expires if not responded to. |
send_reminder_before_expiry_days |
integer | Days before expiry to send reminder notification. |
created |
string (date-time) | |
modified |
string (date-time) |
Create
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
- Model Source:
CallAssignmentConfigurationRequest - API Source:
call_assignment_configurations_create
1 2 3 4 5 6 7 8 9 10 | |
| Field | Type | Required | Description |
|---|---|---|---|
auto_reassign_on_decline |
boolean | Automatically assign next-best reviewer when someone declines. If False, manager must manually approve reassignments. | |
max_auto_reassign_attempts |
integer | Maximum automatic reassignment attempts before requiring manual intervention. | |
assignment_expiration_days |
integer | Days until assignment invitation expires if not responded to. | |
send_reminder_before_expiry_days |
integer | Days before expiry to send reminder notification. |
201 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
call |
string (uri) | |
call_uuid |
string (uuid) | |
call_name |
string | |
auto_reassign_on_decline |
boolean | Automatically assign next-best reviewer when someone declines. If False, manager must manually approve reassignments. |
max_auto_reassign_attempts |
integer | Maximum automatic reassignment attempts before requiring manual intervention. |
assignment_expiration_days |
integer | Days until assignment invitation expires if not responded to. |
send_reminder_before_expiry_days |
integer | Days before expiry to send reminder notification. |
created |
string (date-time) | |
modified |
string (date-time) |
Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
CallAssignmentConfigurationRequest - API Source:
call_assignment_configurations_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
auto_reassign_on_decline |
boolean | Automatically assign next-best reviewer when someone declines. If False, manager must manually approve reassignments. | |
max_auto_reassign_attempts |
integer | Maximum automatic reassignment attempts before requiring manual intervention. | |
assignment_expiration_days |
integer | Days until assignment invitation expires if not responded to. | |
send_reminder_before_expiry_days |
integer | Days before expiry to send reminder notification. |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
call |
string (uri) | |
call_uuid |
string (uuid) | |
call_name |
string | |
auto_reassign_on_decline |
boolean | Automatically assign next-best reviewer when someone declines. If False, manager must manually approve reassignments. |
max_auto_reassign_attempts |
integer | Maximum automatic reassignment attempts before requiring manual intervention. |
assignment_expiration_days |
integer | Days until assignment invitation expires if not responded to. |
send_reminder_before_expiry_days |
integer | Days before expiry to send reminder notification. |
created |
string (date-time) | |
modified |
string (date-time) |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedCallAssignmentConfigurationRequest - API Source:
call_assignment_configurations_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
auto_reassign_on_decline |
boolean | Automatically assign next-best reviewer when someone declines. If False, manager must manually approve reassignments. | |
max_auto_reassign_attempts |
integer | Maximum automatic reassignment attempts before requiring manual intervention. | |
assignment_expiration_days |
integer | Days until assignment invitation expires if not responded to. | |
send_reminder_before_expiry_days |
integer | Days before expiry to send reminder notification. |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
call |
string (uri) | |
call_uuid |
string (uuid) | |
call_name |
string | |
auto_reassign_on_decline |
boolean | Automatically assign next-best reviewer when someone declines. If False, manager must manually approve reassignments. |
max_auto_reassign_attempts |
integer | Maximum automatic reassignment attempts before requiring manual intervention. |
assignment_expiration_days |
integer | Days until assignment invitation expires if not responded to. |
send_reminder_before_expiry_days |
integer | Days before expiry to send reminder notification. |
created |
string (date-time) | |
modified |
string (date-time) |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
call_assignment_configurations_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Call Managing Organisations
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/call-managing-organisations/ |
List Call Managing Organisations |
| GET | /api/call-managing-organisations/{uuid}/ |
Retrieve |
| POST | /api/call-managing-organisations/ |
Create |
| PUT | /api/call-managing-organisations/{uuid}/ |
Update |
| PATCH | /api/call-managing-organisations/{uuid}/ |
Partial Update |
| DELETE | /api/call-managing-organisations/{uuid}/ |
Delete |
| Permissions & Users | ||
| GET | /api/call-managing-organisations/{uuid}/list_users/ |
List users and their roles in a scope |
| POST | /api/call-managing-organisations/{uuid}/add_user/ |
Grant a role to a user |
| POST | /api/call-managing-organisations/{uuid}/delete_user/ |
Revoke a role from a user |
| POST | /api/call-managing-organisations/{uuid}/update_user/ |
Update a user's role expiration |
| Other Actions | ||
| GET | /api/call-managing-organisations/{uuid}/stats/ |
Return statistics for call managing organisation |
Core CRUD
List Call Managing Organisations
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 | |
- Model Source:
CallManagingOrganisationOEnum - API Source:
call_managing_organisations_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
customer |
string (uri) | |
customer_keyword |
string | |
customer_uuid |
string (uuid) | |
o |
array | Ordering |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
created |
string (date-time) |
description |
string |
customer |
string (uri) |
customer_name |
string |
customer_uuid |
string (uuid) |
customer_image |
string (uri) |
customer_abbreviation |
string |
customer_native_name |
string |
customer_country |
string |
image |
string (uri) |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
call_managing_organisations_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
created |
string (date-time) |
description |
string |
customer |
string (uri) |
customer_name |
string |
customer_uuid |
string (uuid) |
customer_image |
string (uri) |
customer_abbreviation |
string |
customer_native_name |
string |
customer_country |
string |
image |
string (uri) |
Create
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
- Model Source:
CallManagingOrganisationRequest - API Source:
call_managing_organisations_create
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Field | Type | Required |
|---|---|---|
description |
string | |
customer |
string (uri) | ✓ |
image |
string (binary) |
201 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
created |
string (date-time) |
description |
string |
customer |
string (uri) |
customer_name |
string |
customer_uuid |
string (uuid) |
customer_image |
string (uri) |
customer_abbreviation |
string |
customer_native_name |
string |
customer_country |
string |
image |
string (uri) |
Update
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
CallManagingOrganisationRequest - API Source:
call_managing_organisations_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
description |
string | |
customer |
string (uri) | ✓ |
image |
string (binary) |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
created |
string (date-time) |
description |
string |
customer |
string (uri) |
customer_name |
string |
customer_uuid |
string (uuid) |
customer_image |
string (uri) |
customer_abbreviation |
string |
customer_native_name |
string |
customer_country |
string |
image |
string (uri) |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedCallManagingOrganisationRequest - API Source:
call_managing_organisations_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
description |
string | |
image |
string (binary) |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
created |
string (date-time) |
description |
string |
customer |
string (uri) |
customer_name |
string |
customer_uuid |
string (uuid) |
customer_image |
string (uri) |
customer_abbreviation |
string |
customer_native_name |
string |
customer_country |
string |
image |
string (uri) |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
call_managing_organisations_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Permissions & Users
List users and their roles in a scope
Retrieves a list of users who have a role within a specific scope (e.g., a project or an organization). The list can be filtered by user details or role.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
- Model Source:
UserRoleDetailsFieldEnum - Model Source:
UserRoleDetailsOEnum - API Source:
call_managing_organisations_list_users_list
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
field |
array | Fields to include in response |
full_name |
string | User full name |
native_name |
string | User native name |
o |
array | Ordering fields |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
role |
string (uuid) | Role UUID or name |
search_string |
string | Search string for user |
user |
string (uuid) | User UUID |
user_slug |
string | User slug |
user_url |
string | User URL |
username |
string | User username |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
created |
string (date-time) | |
expiration_time |
string (date-time) | |
role_name |
string | |
role_uuid |
string (uuid) | |
user_email |
string (email) | |
user_full_name |
string | |
user_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
user_uuid |
string (uuid) | |
user_image |
string (uri) | |
created_by_full_name |
string | |
created_by_uuid |
string (uuid) |
Grant a role to a user
Assigns a specific role to a user within the current scope. An optional expiration time for the role can be set.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
UserRoleCreateRequest - API Source:
call_managing_organisations_add_user
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
role |
string | ✓ |
user |
string (uuid) | ✓ |
expiration_time |
string (date-time) |
201 -
| Field | Type |
|---|---|
expiration_time |
string (date-time) |
400 - Validation error, for example when trying to add a user to a terminated project.
Revoke a role from a user
Removes a specific role from a user within the current scope. This effectively revokes their permissions associated with that role.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
UserRoleDeleteRequest - API Source:
call_managing_organisations_delete_user
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
role |
string | ✓ |
user |
string (uuid) | ✓ |
expiration_time |
string (date-time) |
200 - Role revoked successfully.
Update a user's role expiration
Updates the expiration time for a user's existing role in the current scope. This is useful for extending or shortening the duration of a permission. To make a role permanent, set expiration_time to null.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
UserRoleUpdateRequest - API Source:
call_managing_organisations_update_user
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
role |
string | ✓ |
user |
string (uuid) | ✓ |
expiration_time |
string (date-time) |
200 -
| Field | Type |
|---|---|
expiration_time |
string (date-time) |
Other Actions
Return statistics for call managing organisation
Return statistics for call managing organisation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
call_managing_organisations_stats_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
open_calls |
integer |
active_rounds |
integer |
accepted_proposals |
integer |
pending_proposals |
integer |
pending_review |
integer |
rounds_closing_in_one_week |
integer |
calls_closing_in_one_week |
integer |
offering_requests_pending |
integer |
Call Proposal Project Role Mappings
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/call-proposal-project-role-mappings/ |
List Call Proposal Project Role Mappings |
| GET | /api/call-proposal-project-role-mappings/{uuid}/ |
Retrieve |
| POST | /api/call-proposal-project-role-mappings/ |
Create |
| PUT | /api/call-proposal-project-role-mappings/{uuid}/ |
Update |
| PATCH | /api/call-proposal-project-role-mappings/{uuid}/ |
Partial Update |
| DELETE | /api/call-proposal-project-role-mappings/{uuid}/ |
Delete |
List Call Proposal Project Role Mappings
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
call_proposal_project_role_mappings_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
call_uuid |
string (uuid) | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
call |
string (uri) |
call_uuid |
string (uuid) |
call_name |
string |
proposal_role |
string |
project_role |
string |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
call_proposal_project_role_mappings_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
call |
string (uri) |
call_uuid |
string (uuid) |
call_name |
string |
proposal_role |
string |
project_role |
string |
Create
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
ProposalProjectRoleMappingRequest - API Source:
call_proposal_project_role_mappings_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Field | Type | Required |
|---|---|---|
call |
string (uri) | ✓ |
proposal_role |
string | ✓ |
project_role |
string |
201 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
call |
string (uri) |
call_uuid |
string (uuid) |
call_name |
string |
proposal_role |
string |
project_role |
string |
Update
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
ProposalProjectRoleMappingRequest - API Source:
call_proposal_project_role_mappings_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
call |
string (uri) | ✓ |
proposal_role |
string | ✓ |
project_role |
string |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
call |
string (uri) |
call_uuid |
string (uuid) |
call_name |
string |
proposal_role |
string |
project_role |
string |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedProposalProjectRoleMappingRequest - API Source:
call_proposal_project_role_mappings_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
call |
string (uri) | |
proposal_role |
string | |
project_role |
string |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
call |
string (uri) |
call_uuid |
string (uuid) |
call_name |
string |
proposal_role |
string |
project_role |
string |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
call_proposal_project_role_mappings_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Proposal Protected Calls
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/proposal-protected-calls/ |
List Proposal Protected Calls |
| GET | /api/proposal-protected-calls/{uuid}/ |
Retrieve |
| POST | /api/proposal-protected-calls/ |
Create |
| POST | /api/proposal-protected-calls/{uuid}/create-manual-assignment/ |
Create manual assignment |
| POST | /api/proposal-protected-calls/{uuid}/update_applicant_attribute_config/ |
Create or update applicant attribute exposure configuration |
| PUT | /api/proposal-protected-calls/{uuid}/ |
Update |
| PATCH | /api/proposal-protected-calls/{uuid}/ |
Partial Update |
| PATCH | /api/proposal-protected-calls/{uuid}/update_applicant_attribute_config/ |
Create or update applicant attribute exposure configuration |
| DELETE | /api/proposal-protected-calls/{uuid}/ |
Delete |
| Permissions & Users | ||
| GET | /api/proposal-protected-calls/{uuid}/list_users/ |
List users and their roles in a scope |
| POST | /api/proposal-protected-calls/{uuid}/add_user/ |
Grant a role to a user |
| POST | /api/proposal-protected-calls/{uuid}/delete_user/ |
Revoke a role from a user |
| POST | /api/proposal-protected-calls/{uuid}/update_user/ |
Update a user's role expiration |
| Other Actions | ||
| GET | /api/proposal-protected-calls/{uuid}/affinity-matrix/ |
Get affinity matrix for reviewer-proposal matching |
| GET | /api/proposal-protected-calls/{uuid}/applicant_attribute_config/ |
Get applicant attribute exposure configuration for this call |
| GET | /api/proposal-protected-calls/available_compliance_checklists/ |
Get available compliance checklists for call creation/editing |
| GET | /api/proposal-protected-calls/{uuid}/coi-configuration/ |
Get COI configuration for this call |
| GET | /api/proposal-protected-calls/{uuid}/compliance_overview/ |
Compliance overview |
| GET | /api/proposal-protected-calls/{uuid}/conflict-summary/ |
Get summary statistics of conflicts for this call |
| GET | /api/proposal-protected-calls/{uuid}/conflicts/ |
List all conflicts of interest detected for this call |
| GET | /api/proposal-protected-calls/{uuid}/matching-configuration/ |
Get or update matching configuration for this call |
| GET | /api/proposal-protected-calls/{uuid}/offerings/ |
List offerings for a call |
| GET | /api/proposal-protected-calls/{uuid}/offerings/{obj_uuid}/ |
Retrieve |
| GET | /api/proposal-protected-calls/{uuid}/proposals/{proposal_uuid}/compliance-answers/ |
Get detailed compliance answers for a specific proposal (call managers only) |
| GET | /api/proposal-protected-calls/{uuid}/proposed-assignments/ |
Get proposed reviewer-proposal assignments |
| GET | /api/proposal-protected-calls/{uuid}/resource_templates/ |
List resource templates for a call |
| GET | /api/proposal-protected-calls/{uuid}/resource_templates/{obj_uuid}/ |
Retrieve |
| GET | /api/proposal-protected-calls/{uuid}/reviewer-pool/ |
List reviewer pool members for a call |
| GET | /api/proposal-protected-calls/{uuid}/rounds/ |
List rounds for a call |
| GET | /api/proposal-protected-calls/{uuid}/rounds/{obj_uuid}/ |
Retrieve |
| GET | /api/proposal-protected-calls/{uuid}/suggestions/ |
List all reviewer suggestions for this call with affinity scores |
| POST | /api/proposal-protected-calls/{uuid}/activate/ |
Activate a call |
| POST | /api/proposal-protected-calls/{uuid}/archive/ |
Archive a call |
| POST | /api/proposal-protected-calls/{uuid}/attach_documents/ |
Attach documents to call |
| POST | /api/proposal-protected-calls/{uuid}/compute-affinities/ |
Compute affinity scores for all reviewer-proposal pairs |
| POST | /api/proposal-protected-calls/{uuid}/detach_documents/ |
Detach documents from call |
| POST | /api/proposal-protected-calls/{uuid}/detect-conflicts/ |
Trigger automated COI detection for all reviewer-proposal pairs |
| POST | /api/proposal-protected-calls/{uuid}/generate-assignments/ |
Generate assignments |
| POST | /api/proposal-protected-calls/{uuid}/generate-suggestions/ |
Generate reviewer suggestions with configurable matching source |
| POST | /api/proposal-protected-calls/{uuid}/invite-by-email/ |
Invite by email |
| POST | /api/proposal-protected-calls/{uuid}/reviewer-pool/ |
Invite reviewers to join the call's reviewer pool |
| POST | /api/proposal-protected-calls/{uuid}/offerings/ |
Create offering for a call |
| POST | /api/proposal-protected-calls/{uuid}/resource_templates/ |
Create resource template for a call |
| POST | /api/proposal-protected-calls/{uuid}/review_proposal_compliance/ |
Mark proposal compliance as reviewed by call manager |
| POST | /api/proposal-protected-calls/{uuid}/rounds/{obj_uuid}/close/ |
Close |
| POST | /api/proposal-protected-calls/{uuid}/rounds/ |
Create a round for a call |
| POST | /api/proposal-protected-calls/{uuid}/send-all-assignments/ |
Send all draft assignment batches for this call |
| POST | /api/proposal-protected-calls/{uuid}/send-invitations/ |
Send invitations to all confirmed suggestions |
| PUT | /api/proposal-protected-calls/{uuid}/offerings/{obj_uuid}/ |
Update |
| PUT | /api/proposal-protected-calls/{uuid}/resource_templates/{obj_uuid}/ |
Update |
| PUT | /api/proposal-protected-calls/{uuid}/rounds/{obj_uuid}/ |
Update |
| PATCH | /api/proposal-protected-calls/{uuid}/coi-configuration/ |
Get COI configuration for this call |
| PATCH | /api/proposal-protected-calls/{uuid}/matching-configuration/ |
Get or update matching configuration for this call |
| PATCH | /api/proposal-protected-calls/{uuid}/offerings/{obj_uuid}/ |
Partial Update |
| PATCH | /api/proposal-protected-calls/{uuid}/resource_templates/{obj_uuid}/ |
Partial Update |
| PATCH | /api/proposal-protected-calls/{uuid}/rounds/{obj_uuid}/ |
Partial Update |
| DELETE | /api/proposal-protected-calls/{uuid}/delete_applicant_attribute_config/ |
Delete custom applicant attribute config, reverting to system defaults |
| DELETE | /api/proposal-protected-calls/{uuid}/offerings/{obj_uuid}/ |
Delete |
| DELETE | /api/proposal-protected-calls/{uuid}/resource_templates/{obj_uuid}/ |
Delete |
| DELETE | /api/proposal-protected-calls/{uuid}/rounds/{obj_uuid}/ |
Delete |
Core CRUD
List Proposal Protected Calls
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
CallStates - Model Source:
ProtectedCallFieldEnum - Model Source:
ProtectedCallOEnum - API Source:
proposal_protected_calls_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
customer |
string (uri) | |
customer_keyword |
string | |
customer_uuid |
string (uuid) | |
field |
array | |
has_active_round |
boolean | |
name |
string | |
o |
array | Ordering |
offering_uuid |
string (uuid) | |
offerings_provider_uuid |
string (uuid) | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
state |
array |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
start_date |
string (date-time) | |
end_date |
string (date-time) | |
slug |
string | URL-friendly identifier. Only editable by staff users. |
name |
string | |
description |
string | |
state |
any | |
manager |
string (uri) | |
manager_uuid |
string (uuid) | |
customer_name |
string | |
customer_uuid |
string (uuid) | |
offerings |
array of objects | |
offerings.uuid |
string (uuid) | |
offerings.state |
any | |
offerings.offering |
string (uri) | |
offerings.offering_name |
string | |
offerings.offering_uuid |
string (uuid) | |
offerings.provider_name |
string | |
offerings.category_uuid |
string (uuid) | |
offerings.category_name |
string | |
offerings.call_managing_organisation |
string | |
offerings.attributes |
any | |
offerings.plan |
string (uri) | |
offerings.plan_details |
any | |
offerings.options |
any | |
offerings.components |
array of objects | |
offerings.components.uuid |
string (uuid) | |
offerings.components.billing_type |
string | Enum: fixed, usage, limit, one, few |
offerings.components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
offerings.components.name |
string | Display name for the measured unit, for example, Floating IP. |
offerings.components.description |
string | |
offerings.components.measured_unit |
string | Unit of measurement, for example, GB. |
offerings.components.unit_factor |
integer | The conversion factor from backend units to measured_unit |
offerings.components.limit_period |
any | |
offerings.components.limit_amount |
integer | |
offerings.components.article_code |
string | |
offerings.components.max_value |
integer | |
offerings.components.min_value |
integer | |
offerings.components.max_available_limit |
integer | |
offerings.components.is_boolean |
boolean | |
offerings.components.default_limit |
integer | |
offerings.components.factor |
integer | |
offerings.components.is_builtin |
boolean | |
offerings.components.is_prepaid |
boolean | |
offerings.components.overage_component |
string (uuid) | |
offerings.components.min_prepaid_duration |
integer | |
offerings.components.max_prepaid_duration |
integer | |
offerings.created |
string (date-time) | |
rounds |
array of objects | |
rounds.uuid |
string (uuid) | |
rounds.slug |
string | |
rounds.name |
string | |
rounds.start_time |
string (date-time) | |
rounds.cutoff_time |
string (date-time) | |
rounds.status |
any | |
rounds.review_strategy |
string | Enum: after_round, after_proposal |
rounds.deciding_entity |
string | Enum: by_call_manager, automatic |
rounds.allocation_time |
string | Enum: on_decision, fixed_date |
rounds.allocation_date |
string (date-time) | |
rounds.minimal_average_scoring |
string (decimal) | |
rounds.review_duration_in_days |
integer | |
rounds.minimum_number_of_reviewers |
integer | |
documents |
array of objects | |
documents.uuid |
string (uuid) | |
documents.file |
string (uri) | Documentation for call for proposals. |
documents.file_name |
string | |
documents.file_size |
integer | |
documents.description |
string | |
documents.created |
string (date-time) | |
resource_templates |
array of objects | |
resource_templates.uuid |
string (uuid) | |
resource_templates.url |
string | |
resource_templates.name |
string | |
resource_templates.description |
string | |
resource_templates.attributes |
any | |
resource_templates.limits |
any | |
resource_templates.is_required |
boolean | If True, every proposal must include this resource type |
resource_templates.requested_offering |
string (uri) | |
resource_templates.requested_offering_name |
string | |
resource_templates.requested_offering_uuid |
string (uuid) | |
resource_templates.requested_offering_plan |
any | |
resource_templates.created_by |
string (uri) | |
resource_templates.created_by_name |
string | |
resource_templates.created |
string (date-time) | |
fixed_duration_in_days |
integer | |
backend_id |
string | |
external_url |
string (uri) | |
reviewer_identity_visible_to_submitters |
boolean | Whether proposal applicants can see reviewer identities |
reviews_visible_to_submitters |
boolean | Whether proposal applicants can see review comments and scores |
has_eligibility_restrictions |
boolean | Check if call has any eligibility restrictions configured. |
created_by |
string (uri) | |
reference_code |
string | |
compliance_checklist |
string (uuid) | Compliance checklist that proposals must complete before submission |
compliance_checklist_name |
string | |
proposal_slug_template |
string | Template for proposal slugs. Supports: {call_slug}, {round_slug}, {org_slug}, {year}, {month}, {counter}, {counter_padded}. Default: {round_slug}-{counter_padded} |
user_email_patterns |
any | List of email regex patterns. User must match one. |
user_affiliations |
any | List of allowed affiliations. User must have one. |
user_identity_sources |
any | List of allowed identity sources (identity providers). |
user_nationalities |
any | List of allowed nationality codes (ISO 3166-1 alpha-2). User must have one. |
user_organization_types |
any | List of allowed organization type URNs (SCHAC). User must match one. |
user_assurance_levels |
any | List of required assurance URIs (REFEDS). User must have ALL of these. |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
ProtectedCallFieldEnum - API Source:
proposal_protected_calls_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
start_date |
string (date-time) | |
end_date |
string (date-time) | |
slug |
string | URL-friendly identifier. Only editable by staff users. |
name |
string | |
description |
string | |
state |
any | |
manager |
string (uri) | |
manager_uuid |
string (uuid) | |
customer_name |
string | |
customer_uuid |
string (uuid) | |
offerings |
array of objects | |
offerings.uuid |
string (uuid) | |
offerings.state |
any | |
offerings.offering |
string (uri) | |
offerings.offering_name |
string | |
offerings.offering_uuid |
string (uuid) | |
offerings.provider_name |
string | |
offerings.category_uuid |
string (uuid) | |
offerings.category_name |
string | |
offerings.call_managing_organisation |
string | |
offerings.attributes |
any | |
offerings.plan |
string (uri) | |
offerings.plan_details |
any | |
offerings.options |
any | |
offerings.components |
array of objects | |
offerings.components.uuid |
string (uuid) | |
offerings.components.billing_type |
string | Enum: fixed, usage, limit, one, few |
offerings.components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
offerings.components.name |
string | Display name for the measured unit, for example, Floating IP. |
offerings.components.description |
string | |
offerings.components.measured_unit |
string | Unit of measurement, for example, GB. |
offerings.components.unit_factor |
integer | The conversion factor from backend units to measured_unit |
offerings.components.limit_period |
any | |
offerings.components.limit_amount |
integer | |
offerings.components.article_code |
string | |
offerings.components.max_value |
integer | |
offerings.components.min_value |
integer | |
offerings.components.max_available_limit |
integer | |
offerings.components.is_boolean |
boolean | |
offerings.components.default_limit |
integer | |
offerings.components.factor |
integer | |
offerings.components.is_builtin |
boolean | |
offerings.components.is_prepaid |
boolean | |
offerings.components.overage_component |
string (uuid) | |
offerings.components.min_prepaid_duration |
integer | |
offerings.components.max_prepaid_duration |
integer | |
offerings.created |
string (date-time) | |
rounds |
array of objects | |
rounds.uuid |
string (uuid) | |
rounds.slug |
string | |
rounds.name |
string | |
rounds.start_time |
string (date-time) | |
rounds.cutoff_time |
string (date-time) | |
rounds.status |
any | |
rounds.review_strategy |
string | Enum: after_round, after_proposal |
rounds.deciding_entity |
string | Enum: by_call_manager, automatic |
rounds.allocation_time |
string | Enum: on_decision, fixed_date |
rounds.allocation_date |
string (date-time) | |
rounds.minimal_average_scoring |
string (decimal) | |
rounds.review_duration_in_days |
integer | |
rounds.minimum_number_of_reviewers |
integer | |
documents |
array of objects | |
documents.uuid |
string (uuid) | |
documents.file |
string (uri) | Documentation for call for proposals. |
documents.file_name |
string | |
documents.file_size |
integer | |
documents.description |
string | |
documents.created |
string (date-time) | |
resource_templates |
array of objects | |
resource_templates.uuid |
string (uuid) | |
resource_templates.url |
string | |
resource_templates.name |
string | |
resource_templates.description |
string | |
resource_templates.attributes |
any | |
resource_templates.limits |
any | |
resource_templates.is_required |
boolean | If True, every proposal must include this resource type |
resource_templates.requested_offering |
string (uri) | |
resource_templates.requested_offering_name |
string | |
resource_templates.requested_offering_uuid |
string (uuid) | |
resource_templates.requested_offering_plan |
any | |
resource_templates.created_by |
string (uri) | |
resource_templates.created_by_name |
string | |
resource_templates.created |
string (date-time) | |
fixed_duration_in_days |
integer | |
backend_id |
string | |
external_url |
string (uri) | |
reviewer_identity_visible_to_submitters |
boolean | Whether proposal applicants can see reviewer identities |
reviews_visible_to_submitters |
boolean | Whether proposal applicants can see review comments and scores |
has_eligibility_restrictions |
boolean | Check if call has any eligibility restrictions configured. |
created_by |
string (uri) | |
reference_code |
string | |
compliance_checklist |
string (uuid) | Compliance checklist that proposals must complete before submission |
compliance_checklist_name |
string | |
proposal_slug_template |
string | Template for proposal slugs. Supports: {call_slug}, {round_slug}, {org_slug}, {year}, {month}, {counter}, {counter_padded}. Default: {round_slug}-{counter_padded} |
user_email_patterns |
any | List of email regex patterns. User must match one. |
user_affiliations |
any | List of allowed affiliations. User must have one. |
user_identity_sources |
any | List of allowed identity sources (identity providers). |
user_nationalities |
any | List of allowed nationality codes (ISO 3166-1 alpha-2). User must have one. |
user_organization_types |
any | List of allowed organization type URNs (SCHAC). User must match one. |
user_assurance_levels |
any | List of required assurance URIs (REFEDS). User must have ALL of these. |
Create
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
ProtectedCallRequest - API Source:
proposal_protected_calls_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Field | Type | Required | Description |
|---|---|---|---|
slug |
string | URL-friendly identifier. Only editable by staff users. | |
name |
string | ✓ | |
description |
string | ||
manager |
string (uri) | ✓ | |
fixed_duration_in_days |
integer | ||
backend_id |
string | ||
external_url |
string (uri) | ||
reviewer_identity_visible_to_submitters |
boolean | Whether proposal applicants can see reviewer identities | |
reviews_visible_to_submitters |
boolean | Whether proposal applicants can see review comments and scores | |
created_by |
string (uri) | ||
reference_code |
string | ||
compliance_checklist |
string (uuid) | Compliance checklist that proposals must complete before submission | |
proposal_slug_template |
string | Template for proposal slugs. Supports: {call_slug}, {round_slug}, {org_slug}, {year}, {month}, {counter}, {counter_padded}. Default: {round_slug}-{counter_padded} | |
user_email_patterns |
any | List of email regex patterns. User must match one. | |
user_affiliations |
any | List of allowed affiliations. User must have one. | |
user_identity_sources |
any | List of allowed identity sources (identity providers). | |
user_nationalities |
any | List of allowed nationality codes (ISO 3166-1 alpha-2). User must have one. | |
user_organization_types |
any | List of allowed organization type URNs (SCHAC). User must match one. | |
user_assurance_levels |
any | List of required assurance URIs (REFEDS). User must have ALL of these. |
201 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
start_date |
string (date-time) | |
end_date |
string (date-time) | |
slug |
string | URL-friendly identifier. Only editable by staff users. |
name |
string | |
description |
string | |
state |
any | |
manager |
string (uri) | |
manager_uuid |
string (uuid) | |
customer_name |
string | |
customer_uuid |
string (uuid) | |
offerings |
array of objects | |
offerings.uuid |
string (uuid) | |
offerings.state |
any | |
offerings.offering |
string (uri) | |
offerings.offering_name |
string | |
offerings.offering_uuid |
string (uuid) | |
offerings.provider_name |
string | |
offerings.category_uuid |
string (uuid) | |
offerings.category_name |
string | |
offerings.call_managing_organisation |
string | |
offerings.attributes |
any | |
offerings.plan |
string (uri) | |
offerings.plan_details |
any | |
offerings.options |
any | |
offerings.components |
array of objects | |
offerings.components.uuid |
string (uuid) | |
offerings.components.billing_type |
string | Enum: fixed, usage, limit, one, few |
offerings.components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
offerings.components.name |
string | Display name for the measured unit, for example, Floating IP. |
offerings.components.description |
string | |
offerings.components.measured_unit |
string | Unit of measurement, for example, GB. |
offerings.components.unit_factor |
integer | The conversion factor from backend units to measured_unit |
offerings.components.limit_period |
any | |
offerings.components.limit_amount |
integer | |
offerings.components.article_code |
string | |
offerings.components.max_value |
integer | |
offerings.components.min_value |
integer | |
offerings.components.max_available_limit |
integer | |
offerings.components.is_boolean |
boolean | |
offerings.components.default_limit |
integer | |
offerings.components.factor |
integer | |
offerings.components.is_builtin |
boolean | |
offerings.components.is_prepaid |
boolean | |
offerings.components.overage_component |
string (uuid) | |
offerings.components.min_prepaid_duration |
integer | |
offerings.components.max_prepaid_duration |
integer | |
offerings.created |
string (date-time) | |
rounds |
array of objects | |
rounds.uuid |
string (uuid) | |
rounds.slug |
string | |
rounds.name |
string | |
rounds.start_time |
string (date-time) | |
rounds.cutoff_time |
string (date-time) | |
rounds.status |
any | |
rounds.review_strategy |
string | Enum: after_round, after_proposal |
rounds.deciding_entity |
string | Enum: by_call_manager, automatic |
rounds.allocation_time |
string | Enum: on_decision, fixed_date |
rounds.allocation_date |
string (date-time) | |
rounds.minimal_average_scoring |
string (decimal) | |
rounds.review_duration_in_days |
integer | |
rounds.minimum_number_of_reviewers |
integer | |
documents |
array of objects | |
documents.uuid |
string (uuid) | |
documents.file |
string (uri) | Documentation for call for proposals. |
documents.file_name |
string | |
documents.file_size |
integer | |
documents.description |
string | |
documents.created |
string (date-time) | |
resource_templates |
array of objects | |
resource_templates.uuid |
string (uuid) | |
resource_templates.url |
string | |
resource_templates.name |
string | |
resource_templates.description |
string | |
resource_templates.attributes |
any | |
resource_templates.limits |
any | |
resource_templates.is_required |
boolean | If True, every proposal must include this resource type |
resource_templates.requested_offering |
string (uri) | |
resource_templates.requested_offering_name |
string | |
resource_templates.requested_offering_uuid |
string (uuid) | |
resource_templates.requested_offering_plan |
any | |
resource_templates.created_by |
string (uri) | |
resource_templates.created_by_name |
string | |
resource_templates.created |
string (date-time) | |
fixed_duration_in_days |
integer | |
backend_id |
string | |
external_url |
string (uri) | |
reviewer_identity_visible_to_submitters |
boolean | Whether proposal applicants can see reviewer identities |
reviews_visible_to_submitters |
boolean | Whether proposal applicants can see review comments and scores |
has_eligibility_restrictions |
boolean | Check if call has any eligibility restrictions configured. |
created_by |
string (uri) | |
reference_code |
string | |
compliance_checklist |
string (uuid) | Compliance checklist that proposals must complete before submission |
compliance_checklist_name |
string | |
proposal_slug_template |
string | Template for proposal slugs. Supports: {call_slug}, {round_slug}, {org_slug}, {year}, {month}, {counter}, {counter_padded}. Default: {round_slug}-{counter_padded} |
user_email_patterns |
any | List of email regex patterns. User must match one. |
user_affiliations |
any | List of allowed affiliations. User must have one. |
user_identity_sources |
any | List of allowed identity sources (identity providers). |
user_nationalities |
any | List of allowed nationality codes (ISO 3166-1 alpha-2). User must have one. |
user_organization_types |
any | List of allowed organization type URNs (SCHAC). User must match one. |
user_assurance_levels |
any | List of required assurance URIs (REFEDS). User must have ALL of these. |
Create manual assignment
Create a manual assignment batch for a specific reviewer. This allows call managers to manually assign proposals to reviewers.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
CreateManualAssignmentRequest - API Source:
proposal_protected_calls_create_manual_assignment
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
reviewer_pool_entry_uuid |
string (uuid) | ✓ | UUID of the reviewer pool entry to assign proposals to |
proposal_uuids |
array of string (uuid)s | ✓ | List of proposal UUIDs to assign to the reviewer |
manager_notes |
string | Optional notes about this assignment |
200 -
| Field | Type | Description |
|---|---|---|
batch_uuid |
string (uuid) | |
items_created |
integer | |
skipped_proposals |
array of objects | Proposals that were skipped with reasons |
Create or update applicant attribute exposure configuration
Create or update applicant attribute exposure configuration.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
CallApplicantAttributeConfigRequest - API Source:
proposal_protected_calls_update_applicant_attribute_config
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
call |
string (uuid) | Constraints: write-only |
|
expose_full_name |
boolean | ||
expose_email |
boolean | ||
expose_organization |
boolean | ||
expose_affiliations |
boolean | ||
expose_organization_type |
boolean | ||
expose_organization_country |
boolean | ||
expose_nationality |
boolean | ||
expose_nationalities |
boolean | ||
expose_country_of_residence |
boolean | ||
expose_eduperson_assurance |
boolean | ||
expose_identity_source |
boolean | ||
reviewers_see_applicant_details |
boolean | If True, reviewers see applicant identity. If False, proposals are anonymized for reviewers. |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
call_uuid |
string (uuid) | |
call_name |
string | |
expose_full_name |
boolean | |
expose_email |
boolean | |
expose_organization |
boolean | |
expose_affiliations |
boolean | |
expose_organization_type |
boolean | |
expose_organization_country |
boolean | |
expose_nationality |
boolean | |
expose_nationalities |
boolean | |
expose_country_of_residence |
boolean | |
expose_eduperson_assurance |
boolean | |
expose_identity_source |
boolean | |
reviewers_see_applicant_details |
boolean | If True, reviewers see applicant identity. If False, proposals are anonymized for reviewers. |
exposed_fields |
array of strings | Return list of currently exposed field names. |
is_default |
boolean | Return True if this is a default (unsaved) config. |
Update
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
ProtectedCallRequest - API Source:
proposal_protected_calls_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
slug |
string | URL-friendly identifier. Only editable by staff users. | |
name |
string | ✓ | |
description |
string | ||
manager |
string (uri) | ✓ | |
fixed_duration_in_days |
integer | ||
backend_id |
string | ||
external_url |
string (uri) | ||
reviewer_identity_visible_to_submitters |
boolean | Whether proposal applicants can see reviewer identities | |
reviews_visible_to_submitters |
boolean | Whether proposal applicants can see review comments and scores | |
created_by |
string (uri) | ||
reference_code |
string | ||
compliance_checklist |
string (uuid) | Compliance checklist that proposals must complete before submission | |
proposal_slug_template |
string | Template for proposal slugs. Supports: {call_slug}, {round_slug}, {org_slug}, {year}, {month}, {counter}, {counter_padded}. Default: {round_slug}-{counter_padded} | |
user_email_patterns |
any | List of email regex patterns. User must match one. | |
user_affiliations |
any | List of allowed affiliations. User must have one. | |
user_identity_sources |
any | List of allowed identity sources (identity providers). | |
user_nationalities |
any | List of allowed nationality codes (ISO 3166-1 alpha-2). User must have one. | |
user_organization_types |
any | List of allowed organization type URNs (SCHAC). User must match one. | |
user_assurance_levels |
any | List of required assurance URIs (REFEDS). User must have ALL of these. |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
start_date |
string (date-time) | |
end_date |
string (date-time) | |
slug |
string | URL-friendly identifier. Only editable by staff users. |
name |
string | |
description |
string | |
state |
any | |
manager |
string (uri) | |
manager_uuid |
string (uuid) | |
customer_name |
string | |
customer_uuid |
string (uuid) | |
offerings |
array of objects | |
offerings.uuid |
string (uuid) | |
offerings.state |
any | |
offerings.offering |
string (uri) | |
offerings.offering_name |
string | |
offerings.offering_uuid |
string (uuid) | |
offerings.provider_name |
string | |
offerings.category_uuid |
string (uuid) | |
offerings.category_name |
string | |
offerings.call_managing_organisation |
string | |
offerings.attributes |
any | |
offerings.plan |
string (uri) | |
offerings.plan_details |
any | |
offerings.options |
any | |
offerings.components |
array of objects | |
offerings.components.uuid |
string (uuid) | |
offerings.components.billing_type |
string | Enum: fixed, usage, limit, one, few |
offerings.components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
offerings.components.name |
string | Display name for the measured unit, for example, Floating IP. |
offerings.components.description |
string | |
offerings.components.measured_unit |
string | Unit of measurement, for example, GB. |
offerings.components.unit_factor |
integer | The conversion factor from backend units to measured_unit |
offerings.components.limit_period |
any | |
offerings.components.limit_amount |
integer | |
offerings.components.article_code |
string | |
offerings.components.max_value |
integer | |
offerings.components.min_value |
integer | |
offerings.components.max_available_limit |
integer | |
offerings.components.is_boolean |
boolean | |
offerings.components.default_limit |
integer | |
offerings.components.factor |
integer | |
offerings.components.is_builtin |
boolean | |
offerings.components.is_prepaid |
boolean | |
offerings.components.overage_component |
string (uuid) | |
offerings.components.min_prepaid_duration |
integer | |
offerings.components.max_prepaid_duration |
integer | |
offerings.created |
string (date-time) | |
rounds |
array of objects | |
rounds.uuid |
string (uuid) | |
rounds.slug |
string | |
rounds.name |
string | |
rounds.start_time |
string (date-time) | |
rounds.cutoff_time |
string (date-time) | |
rounds.status |
any | |
rounds.review_strategy |
string | Enum: after_round, after_proposal |
rounds.deciding_entity |
string | Enum: by_call_manager, automatic |
rounds.allocation_time |
string | Enum: on_decision, fixed_date |
rounds.allocation_date |
string (date-time) | |
rounds.minimal_average_scoring |
string (decimal) | |
rounds.review_duration_in_days |
integer | |
rounds.minimum_number_of_reviewers |
integer | |
documents |
array of objects | |
documents.uuid |
string (uuid) | |
documents.file |
string (uri) | Documentation for call for proposals. |
documents.file_name |
string | |
documents.file_size |
integer | |
documents.description |
string | |
documents.created |
string (date-time) | |
resource_templates |
array of objects | |
resource_templates.uuid |
string (uuid) | |
resource_templates.url |
string | |
resource_templates.name |
string | |
resource_templates.description |
string | |
resource_templates.attributes |
any | |
resource_templates.limits |
any | |
resource_templates.is_required |
boolean | If True, every proposal must include this resource type |
resource_templates.requested_offering |
string (uri) | |
resource_templates.requested_offering_name |
string | |
resource_templates.requested_offering_uuid |
string (uuid) | |
resource_templates.requested_offering_plan |
any | |
resource_templates.created_by |
string (uri) | |
resource_templates.created_by_name |
string | |
resource_templates.created |
string (date-time) | |
fixed_duration_in_days |
integer | |
backend_id |
string | |
external_url |
string (uri) | |
reviewer_identity_visible_to_submitters |
boolean | Whether proposal applicants can see reviewer identities |
reviews_visible_to_submitters |
boolean | Whether proposal applicants can see review comments and scores |
has_eligibility_restrictions |
boolean | Check if call has any eligibility restrictions configured. |
created_by |
string (uri) | |
reference_code |
string | |
compliance_checklist |
string (uuid) | Compliance checklist that proposals must complete before submission |
compliance_checklist_name |
string | |
proposal_slug_template |
string | Template for proposal slugs. Supports: {call_slug}, {round_slug}, {org_slug}, {year}, {month}, {counter}, {counter_padded}. Default: {round_slug}-{counter_padded} |
user_email_patterns |
any | List of email regex patterns. User must match one. |
user_affiliations |
any | List of allowed affiliations. User must have one. |
user_identity_sources |
any | List of allowed identity sources (identity providers). |
user_nationalities |
any | List of allowed nationality codes (ISO 3166-1 alpha-2). User must have one. |
user_organization_types |
any | List of allowed organization type URNs (SCHAC). User must match one. |
user_assurance_levels |
any | List of required assurance URIs (REFEDS). User must have ALL of these. |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedProtectedCallRequest - API Source:
proposal_protected_calls_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
slug |
string | URL-friendly identifier. Only editable by staff users. | |
name |
string | ||
description |
string | ||
fixed_duration_in_days |
integer | ||
backend_id |
string | ||
external_url |
string (uri) | ||
reviewer_identity_visible_to_submitters |
boolean | Whether proposal applicants can see reviewer identities | |
reviews_visible_to_submitters |
boolean | Whether proposal applicants can see review comments and scores | |
created_by |
string (uri) | ||
reference_code |
string | ||
compliance_checklist |
string (uuid) | Compliance checklist that proposals must complete before submission | |
proposal_slug_template |
string | Template for proposal slugs. Supports: {call_slug}, {round_slug}, {org_slug}, {year}, {month}, {counter}, {counter_padded}. Default: {round_slug}-{counter_padded} | |
user_email_patterns |
any | List of email regex patterns. User must match one. | |
user_affiliations |
any | List of allowed affiliations. User must have one. | |
user_identity_sources |
any | List of allowed identity sources (identity providers). | |
user_nationalities |
any | List of allowed nationality codes (ISO 3166-1 alpha-2). User must have one. | |
user_organization_types |
any | List of allowed organization type URNs (SCHAC). User must match one. | |
user_assurance_levels |
any | List of required assurance URIs (REFEDS). User must have ALL of these. |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
start_date |
string (date-time) | |
end_date |
string (date-time) | |
slug |
string | URL-friendly identifier. Only editable by staff users. |
name |
string | |
description |
string | |
state |
any | |
manager |
string (uri) | |
manager_uuid |
string (uuid) | |
customer_name |
string | |
customer_uuid |
string (uuid) | |
offerings |
array of objects | |
offerings.uuid |
string (uuid) | |
offerings.state |
any | |
offerings.offering |
string (uri) | |
offerings.offering_name |
string | |
offerings.offering_uuid |
string (uuid) | |
offerings.provider_name |
string | |
offerings.category_uuid |
string (uuid) | |
offerings.category_name |
string | |
offerings.call_managing_organisation |
string | |
offerings.attributes |
any | |
offerings.plan |
string (uri) | |
offerings.plan_details |
any | |
offerings.options |
any | |
offerings.components |
array of objects | |
offerings.components.uuid |
string (uuid) | |
offerings.components.billing_type |
string | Enum: fixed, usage, limit, one, few |
offerings.components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
offerings.components.name |
string | Display name for the measured unit, for example, Floating IP. |
offerings.components.description |
string | |
offerings.components.measured_unit |
string | Unit of measurement, for example, GB. |
offerings.components.unit_factor |
integer | The conversion factor from backend units to measured_unit |
offerings.components.limit_period |
any | |
offerings.components.limit_amount |
integer | |
offerings.components.article_code |
string | |
offerings.components.max_value |
integer | |
offerings.components.min_value |
integer | |
offerings.components.max_available_limit |
integer | |
offerings.components.is_boolean |
boolean | |
offerings.components.default_limit |
integer | |
offerings.components.factor |
integer | |
offerings.components.is_builtin |
boolean | |
offerings.components.is_prepaid |
boolean | |
offerings.components.overage_component |
string (uuid) | |
offerings.components.min_prepaid_duration |
integer | |
offerings.components.max_prepaid_duration |
integer | |
offerings.created |
string (date-time) | |
rounds |
array of objects | |
rounds.uuid |
string (uuid) | |
rounds.slug |
string | |
rounds.name |
string | |
rounds.start_time |
string (date-time) | |
rounds.cutoff_time |
string (date-time) | |
rounds.status |
any | |
rounds.review_strategy |
string | Enum: after_round, after_proposal |
rounds.deciding_entity |
string | Enum: by_call_manager, automatic |
rounds.allocation_time |
string | Enum: on_decision, fixed_date |
rounds.allocation_date |
string (date-time) | |
rounds.minimal_average_scoring |
string (decimal) | |
rounds.review_duration_in_days |
integer | |
rounds.minimum_number_of_reviewers |
integer | |
documents |
array of objects | |
documents.uuid |
string (uuid) | |
documents.file |
string (uri) | Documentation for call for proposals. |
documents.file_name |
string | |
documents.file_size |
integer | |
documents.description |
string | |
documents.created |
string (date-time) | |
resource_templates |
array of objects | |
resource_templates.uuid |
string (uuid) | |
resource_templates.url |
string | |
resource_templates.name |
string | |
resource_templates.description |
string | |
resource_templates.attributes |
any | |
resource_templates.limits |
any | |
resource_templates.is_required |
boolean | If True, every proposal must include this resource type |
resource_templates.requested_offering |
string (uri) | |
resource_templates.requested_offering_name |
string | |
resource_templates.requested_offering_uuid |
string (uuid) | |
resource_templates.requested_offering_plan |
any | |
resource_templates.created_by |
string (uri) | |
resource_templates.created_by_name |
string | |
resource_templates.created |
string (date-time) | |
fixed_duration_in_days |
integer | |
backend_id |
string | |
external_url |
string (uri) | |
reviewer_identity_visible_to_submitters |
boolean | Whether proposal applicants can see reviewer identities |
reviews_visible_to_submitters |
boolean | Whether proposal applicants can see review comments and scores |
has_eligibility_restrictions |
boolean | Check if call has any eligibility restrictions configured. |
created_by |
string (uri) | |
reference_code |
string | |
compliance_checklist |
string (uuid) | Compliance checklist that proposals must complete before submission |
compliance_checklist_name |
string | |
proposal_slug_template |
string | Template for proposal slugs. Supports: {call_slug}, {round_slug}, {org_slug}, {year}, {month}, {counter}, {counter_padded}. Default: {round_slug}-{counter_padded} |
user_email_patterns |
any | List of email regex patterns. User must match one. |
user_affiliations |
any | List of allowed affiliations. User must have one. |
user_identity_sources |
any | List of allowed identity sources (identity providers). |
user_nationalities |
any | List of allowed nationality codes (ISO 3166-1 alpha-2). User must have one. |
user_organization_types |
any | List of allowed organization type URNs (SCHAC). User must match one. |
user_assurance_levels |
any | List of required assurance URIs (REFEDS). User must have ALL of these. |
Create or update applicant attribute exposure configuration
Create or update applicant attribute exposure configuration.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
call |
string (uuid) | Constraints: write-only |
|
expose_full_name |
boolean | ||
expose_email |
boolean | ||
expose_organization |
boolean | ||
expose_affiliations |
boolean | ||
expose_organization_type |
boolean | ||
expose_organization_country |
boolean | ||
expose_nationality |
boolean | ||
expose_nationalities |
boolean | ||
expose_country_of_residence |
boolean | ||
expose_eduperson_assurance |
boolean | ||
expose_identity_source |
boolean | ||
reviewers_see_applicant_details |
boolean | If True, reviewers see applicant identity. If False, proposals are anonymized for reviewers. |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
call_uuid |
string (uuid) | |
call_name |
string | |
expose_full_name |
boolean | |
expose_email |
boolean | |
expose_organization |
boolean | |
expose_affiliations |
boolean | |
expose_organization_type |
boolean | |
expose_organization_country |
boolean | |
expose_nationality |
boolean | |
expose_nationalities |
boolean | |
expose_country_of_residence |
boolean | |
expose_eduperson_assurance |
boolean | |
expose_identity_source |
boolean | |
reviewers_see_applicant_details |
boolean | If True, reviewers see applicant identity. If False, proposals are anonymized for reviewers. |
exposed_fields |
array of strings | Return list of currently exposed field names. |
is_default |
boolean | Return True if this is a default (unsaved) config. |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
proposal_protected_calls_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Permissions & Users
List users and their roles in a scope
Retrieves a list of users who have a role within a specific scope (e.g., a project or an organization). The list can be filtered by user details or role.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
- Model Source:
UserRoleDetailsFieldEnum - Model Source:
UserRoleDetailsOEnum - API Source:
proposal_protected_calls_list_users_list
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
field |
array | Fields to include in response |
full_name |
string | User full name |
native_name |
string | User native name |
o |
array | Ordering fields |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
role |
string (uuid) | Role UUID or name |
search_string |
string | Search string for user |
user |
string (uuid) | User UUID |
user_slug |
string | User slug |
user_url |
string | User URL |
username |
string | User username |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
created |
string (date-time) | |
expiration_time |
string (date-time) | |
role_name |
string | |
role_uuid |
string (uuid) | |
user_email |
string (email) | |
user_full_name |
string | |
user_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
user_uuid |
string (uuid) | |
user_image |
string (uri) | |
created_by_full_name |
string | |
created_by_uuid |
string (uuid) |
Grant a role to a user
Assigns a specific role to a user within the current scope. An optional expiration time for the role can be set.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
UserRoleCreateRequest - API Source:
proposal_protected_calls_add_user
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
role |
string | ✓ |
user |
string (uuid) | ✓ |
expiration_time |
string (date-time) |
201 -
| Field | Type |
|---|---|
expiration_time |
string (date-time) |
400 - Validation error, for example when trying to add a user to a terminated project.
Revoke a role from a user
Removes a specific role from a user within the current scope. This effectively revokes their permissions associated with that role.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
UserRoleDeleteRequest - API Source:
proposal_protected_calls_delete_user
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
role |
string | ✓ |
user |
string (uuid) | ✓ |
expiration_time |
string (date-time) |
200 - Role revoked successfully.
Update a user's role expiration
Updates the expiration time for a user's existing role in the current scope. This is useful for extending or shortening the duration of a permission. To make a role permanent, set expiration_time to null.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
UserRoleUpdateRequest - API Source:
proposal_protected_calls_update_user
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
role |
string | ✓ |
user |
string (uuid) | ✓ |
expiration_time |
string (date-time) |
200 -
| Field | Type |
|---|---|
expiration_time |
string (date-time) |
Other Actions
Get affinity matrix for reviewer-proposal matching
Get affinity matrix for reviewer-proposal matching.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
AffinityMatrixResponseScopeEnum - API Source:
proposal_protected_calls_affinity_matrix_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
scope |
string | Filter by reviewer source: 'pool' (accepted reviewers), 'suggestions' (suggested reviewers), or 'all' (both). Default: 'pool' Enum: all, pool, suggestions |
200 -
| Field | Type |
|---|---|
count |
integer |
results |
array of objects |
results.uuid |
string (uuid) |
results.reviewer_uuid |
string (uuid) |
results.reviewer_name |
string |
results.proposal_uuid |
string (uuid) |
results.proposal_name |
string |
results.affinity_score |
number (double) |
results.keyword_score |
number (double) |
results.text_score |
number (double) |
results.has_conflict |
boolean |
results.coi_type |
string |
results.coi_severity |
string |
results.coi_status |
string |
results.source |
string |
Get applicant attribute exposure configuration for this call
Get applicant attribute exposure configuration for this call.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
call_uuid |
string (uuid) | |
call_name |
string | |
expose_full_name |
boolean | |
expose_email |
boolean | |
expose_organization |
boolean | |
expose_affiliations |
boolean | |
expose_organization_type |
boolean | |
expose_organization_country |
boolean | |
expose_nationality |
boolean | |
expose_nationalities |
boolean | |
expose_country_of_residence |
boolean | |
expose_eduperson_assurance |
boolean | |
expose_identity_source |
boolean | |
reviewers_see_applicant_details |
boolean | If True, reviewers see applicant identity. If False, proposals are anonymized for reviewers. |
exposed_fields |
array of strings | Return list of currently exposed field names. |
is_default |
boolean | Return True if this is a default (unsaved) config. |
Get available compliance checklists for call creation/editing
Get available compliance checklists for call creation/editing.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
- Model Source:
CallStates - Model Source:
ProtectedCallOEnum - API Source:
proposal_protected_calls_available_compliance_checklists_list
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required | Description |
|---|---|---|---|
checklist_type |
string | Filter by checklist type (default: proposal_compliance) | |
customer |
string (uri) | ||
customer_keyword |
string | ||
customer_uuid |
string | ✓ | Customer UUID to check permissions for. Required to verify user has CREATE_CALL permission on that customer's call managing organization. |
has_active_round |
boolean | ||
name |
string | ||
o |
array | Ordering |
|
offering_uuid |
string (uuid) | ||
offerings_provider_uuid |
string (uuid) | ||
page |
integer | A page number within the paginated result set. | |
page_size |
integer | Number of results to return per page. | |
state |
array |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
uuid |
string (uuid) |
name |
string |
description |
string |
checklist_type |
string |
questions_count |
integer |
category_name |
string |
category_uuid |
string (uuid) |
Get COI configuration for this call
Get COI configuration for this call.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
call |
string (uri) | |
call_uuid |
string (uuid) | |
call_name |
string | |
coauthorship_lookback_years |
integer | Years to look back for co-authorship detection |
coauthorship_threshold_papers |
integer | Minimum shared papers to trigger COI |
institutional_lookback_years |
integer | Years to look back for former institution detection |
include_same_department |
boolean | Detect same-department as COI |
include_same_institution |
boolean | Detect same-institution as COI |
recusal_required_types |
array of strings | COI types requiring automatic recusal |
management_allowed_types |
array of strings | COI types allowing management plan |
disclosure_only_types |
array of strings | COI types requiring disclosure only |
auto_detect_coauthorship |
boolean | Enable automated co-authorship detection |
auto_detect_institutional |
boolean | Enable automated institutional affiliation detection |
auto_detect_named_personnel |
boolean | Enable detection of reviewer named in proposals |
invitation_proposal_disclosure |
any | Level of proposal information disclosed in reviewer invitations |
created |
string (date-time) | |
modified |
string (date-time) |
Compliance overview
Get compliance overview for call manager showing all proposals and their compliance status.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
checklist |
object (free-form) |
proposals |
array of anys |
Get summary statistics of conflicts for this call
Get summary statistics of conflicts for this call.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
total |
integer |
by_status |
object (free-form) |
by_severity |
object (free-form) |
by_type |
object (free-form) |
List all conflicts of interest detected for this call
List all conflicts of interest detected for this call.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
- Model Source:
CallStates - Model Source:
ProtectedCallOEnum - API Source:
proposal_protected_calls_conflicts_list
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
customer |
string (uri) | |
customer_keyword |
string | |
customer_uuid |
string (uuid) | |
has_active_round |
boolean | |
name |
string | |
o |
array | Ordering |
offering_uuid |
string (uuid) | |
offerings_provider_uuid |
string (uuid) | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
state |
array |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
reviewer |
string (uri) | |
reviewer_uuid |
string (uuid) | |
reviewer_name |
string | |
proposal |
string (uri) | |
proposal_uuid |
string (uuid) | |
proposal_name |
string | |
round_uuid |
string (uuid) | |
round_name |
string | |
call |
string (uri) | |
call_uuid |
string (uuid) | |
call_name |
string | |
coi_type |
any | |
coi_type_display |
string | |
severity |
any | |
severity_display |
string | |
detection_method |
any | |
detected_at |
string (date-time) | |
evidence_description |
string | |
evidence_data |
any | Structured evidence: {"papers": [...], "affiliation_overlap": {...}} |
status |
string | Enum: pending, dismissed, waived, recused |
status_display |
string | |
reviewed_by |
string (uri) | |
reviewed_by_name |
string | |
reviewed_at |
string (date-time) | |
review_notes |
string | |
management_plan |
string | If waived, how is it managed |
conflicting_user |
string (uri) | Specific person causing conflict |
conflicting_user_name |
string | |
conflicting_organization |
string (uri) | |
conflicting_organization_name |
string | |
created |
string (date-time) |
Get or update matching configuration for this call
Get or update matching configuration for this call.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
call_uuid |
string (uuid) | |
call_name |
string | |
affinity_method |
string | Enum: keyword, tfidf, combined |
keyword_weight |
number (double) | |
text_weight |
number (double) | |
min_reviewers_per_proposal |
integer | |
max_reviewers_per_proposal |
integer | |
min_proposals_per_reviewer |
integer | |
max_proposals_per_reviewer |
integer | |
algorithm |
string | Enum: minmax, fairflow, hungarian |
min_affinity_threshold |
number (double) | Minimum affinity score for FairFlow algorithm |
use_reviewer_bids |
boolean | |
bid_weight |
number (double) | |
created |
string (date-time) | |
modified |
string (date-time) |
List offerings for a call
List offerings for a call.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- API Source:
proposal_protected_calls_offerings_list
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
state |
string | Filter by state |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
state |
any | |
offering |
string (uri) | |
offering_name |
string | |
offering_uuid |
string (uuid) | |
provider_name |
string | |
category_uuid |
string (uuid) | |
category_name |
string | |
call_managing_organisation |
string | |
attributes |
any | |
plan |
string (uri) | |
plan_details |
any | |
options |
any | |
components |
array of objects | |
components.uuid |
string (uuid) | |
components.billing_type |
string | Enum: fixed, usage, limit, one, few |
components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
components.name |
string | Display name for the measured unit, for example, Floating IP. |
components.description |
string | |
components.measured_unit |
string | Unit of measurement, for example, GB. |
components.unit_factor |
integer | The conversion factor from backend units to measured_unit |
components.limit_period |
any | |
components.limit_amount |
integer | |
components.article_code |
string | |
components.max_value |
integer | |
components.min_value |
integer | |
components.max_available_limit |
integer | |
components.is_boolean |
boolean | |
components.default_limit |
integer | |
components.factor |
integer | |
components.is_builtin |
boolean | |
components.is_prepaid |
boolean | |
components.overage_component |
string (uuid) | |
components.min_prepaid_duration |
integer | |
components.max_prepaid_duration |
integer | |
created |
string (date-time) | |
url |
string | |
approved_by |
string (uri) | |
created_by |
string (uri) | |
created_by_name |
string | |
approved_by_name |
string | |
description |
string |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- API Source:
proposal_protected_calls_offerings_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Name | Type | Required |
|---|---|---|
obj_uuid |
string | ✓ |
uuid |
string | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
state |
any | |
offering |
string (uri) | |
offering_name |
string | |
offering_uuid |
string (uuid) | |
provider_name |
string | |
category_uuid |
string (uuid) | |
category_name |
string | |
call_managing_organisation |
string | |
attributes |
any | |
plan |
string (uri) | |
plan_details |
any | |
options |
any | |
components |
array of objects | |
components.uuid |
string (uuid) | |
components.billing_type |
string | Enum: fixed, usage, limit, one, few |
components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
components.name |
string | Display name for the measured unit, for example, Floating IP. |
components.description |
string | |
components.measured_unit |
string | Unit of measurement, for example, GB. |
components.unit_factor |
integer | The conversion factor from backend units to measured_unit |
components.limit_period |
any | |
components.limit_amount |
integer | |
components.article_code |
string | |
components.max_value |
integer | |
components.min_value |
integer | |
components.max_available_limit |
integer | |
components.is_boolean |
boolean | |
components.default_limit |
integer | |
components.factor |
integer | |
components.is_builtin |
boolean | |
components.is_prepaid |
boolean | |
components.overage_component |
string (uuid) | |
components.min_prepaid_duration |
integer | |
components.max_prepaid_duration |
integer | |
created |
string (date-time) | |
url |
string | |
approved_by |
string (uri) | |
created_by |
string (uri) | |
created_by_name |
string | |
approved_by_name |
string | |
description |
string |
Get detailed compliance answers for a specific proposal (call managers only)
Get detailed compliance answers for a specific proposal (call managers only).
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
CallStates - Model Source:
ProtectedCallOEnum - API Source:
proposal_protected_calls_proposals_compliance_answers_list
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Name | Type | Required | Description |
|---|---|---|---|
proposal_uuid |
string | ✓ | UUID of the proposal |
uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
customer |
string (uri) | |
customer_keyword |
string | |
customer_uuid |
string (uuid) | |
has_active_round |
boolean | |
name |
string | |
o |
array | Ordering |
offering_uuid |
string (uuid) | |
offerings_provider_uuid |
string (uuid) | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
state |
array |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
question_description |
string | |
question_type |
string | |
question_required |
boolean | |
answer_data |
any | Flexible answer storage for different question types |
requires_review |
boolean | Internal flag - this answer requires additional review |
user |
integer | |
user_name |
string | |
created |
string (date-time) | |
modified |
string (date-time) |
Get proposed reviewer-proposal assignments
Get proposed reviewer-proposal assignments.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
- Model Source:
CallStates - Model Source:
ProtectedCallOEnum - API Source:
proposal_protected_calls_proposed_assignments_list
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
customer |
string (uri) | |
customer_keyword |
string | |
customer_uuid |
string (uuid) | |
has_active_round |
boolean | |
name |
string | |
o |
array | Ordering |
offering_uuid |
string (uuid) | |
offerings_provider_uuid |
string (uuid) | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
state |
array |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
call |
string (uri) | |
reviewer |
string (uri) | |
reviewer_uuid |
string (uuid) | |
reviewer_name |
string | |
proposal |
string (uri) | |
proposal_uuid |
string (uuid) | |
proposal_name |
string | |
affinity_score |
number (double) | |
algorithm_used |
any | |
rank |
integer | Assignment rank (1 = best match) |
is_deployed |
boolean | |
deployed_at |
string (date-time) | |
deployed_by |
string (uri) | |
deployed_by_name |
string | |
created |
string (date-time) |
List resource templates for a call
List resource templates for a call.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- API Source:
proposal_protected_calls_resource_templates_list
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string | |
name |
string | |
description |
string | |
attributes |
any | |
limits |
any | |
is_required |
boolean | If True, every proposal must include this resource type |
requested_offering |
string (uri) | |
requested_offering_name |
string | |
requested_offering_uuid |
string (uuid) | |
requested_offering_plan |
any | |
created_by |
string (uri) | |
created_by_name |
string | |
created |
string (date-time) |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Name | Type | Required |
|---|---|---|
obj_uuid |
string | ✓ |
uuid |
string | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string | |
name |
string | |
description |
string | |
attributes |
any | |
limits |
any | |
is_required |
boolean | If True, every proposal must include this resource type |
requested_offering |
string (uri) | |
requested_offering_name |
string | |
requested_offering_uuid |
string (uuid) | |
requested_offering_plan |
any | |
created_by |
string (uri) | |
created_by_name |
string | |
created |
string (date-time) |
List reviewer pool members for a call
List reviewer pool members for a call.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- API Source:
proposal_protected_calls_reviewer_pool_list
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
call |
string (uri) | |
call_uuid |
string (uuid) | |
call_name |
string | |
reviewer |
string (uri) | |
reviewer_uuid |
string | Get reviewer profile UUID if available. |
reviewer_name |
string | Get reviewer name from profile or invited_user. |
reviewer_email |
string | Get email from profile, invited_user, or invited_email. |
has_profile |
boolean | Check if reviewer has a profile. |
invited_email |
string (email) | Email address for direct invitations |
invited_user |
string (uri) | Waldur user if email matches existing account |
invited_user_name |
string | |
invited_at |
string (date-time) | |
invitation_status |
any | |
invitation_status_display |
string | |
response_date |
string (date-time) | |
decline_reason |
string | |
max_assignments |
integer | |
current_assignments |
integer | |
expertise_match_score |
number (double) | Calculated affinity to call topics (0-1) |
invited_by_name |
string | |
invitation_token |
string | |
invitation_expires_at |
string (date-time) | |
created |
string (date-time) | |
coi_count |
integer | Count total COIs for this reviewer in this call. |
coi_by_severity |
object (free-form) | Count COIs by severity level. |
reviews_pending |
integer | Legacy field - always returns 0. Previously counted reviews in 'created' state, but that state has been removed. Reviews are now created directly in 'in_review' state. Kept for backwards compatibility with frontend. |
reviews_in_progress |
integer | Count reviews in 'in_review' state. |
reviews_completed |
integer | Count reviews in 'submitted' state. |
List rounds for a call
List rounds for a call.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- API Source:
proposal_protected_calls_rounds_list
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
slug |
string | |
name |
string | |
start_time |
string (date-time) | |
cutoff_time |
string (date-time) | |
status |
any | |
review_strategy |
string | Enum: after_round, after_proposal |
deciding_entity |
string | Enum: by_call_manager, automatic |
allocation_time |
string | Enum: on_decision, fixed_date |
allocation_date |
string (date-time) | |
minimal_average_scoring |
string (decimal) | |
review_duration_in_days |
integer | |
minimum_number_of_reviewers |
integer | |
url |
string | |
proposals |
array of objects | |
proposals.uuid |
string (uuid) | |
proposals.slug |
string | |
proposals.name |
string | |
proposals.state |
any | |
proposals.reviews |
array of anys | Return serialized reviews based on user permissions and visibility settings. - Staff, call managers, and reviewers see all reviews. - Submitters see submitted reviews if visibility is enabled. |
proposals.approved_by_name |
string | |
proposals.created_by_name |
string | |
proposals.created |
string (date-time) |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- API Source:
proposal_protected_calls_rounds_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Name | Type | Required |
|---|---|---|
obj_uuid |
string | ✓ |
uuid |
string | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
slug |
string | |
name |
string | |
start_time |
string (date-time) | |
cutoff_time |
string (date-time) | |
status |
any | |
review_strategy |
string | Enum: after_round, after_proposal |
deciding_entity |
string | Enum: by_call_manager, automatic |
allocation_time |
string | Enum: on_decision, fixed_date |
allocation_date |
string (date-time) | |
minimal_average_scoring |
string (decimal) | |
review_duration_in_days |
integer | |
minimum_number_of_reviewers |
integer | |
url |
string | |
proposals |
array of objects | |
proposals.uuid |
string (uuid) | |
proposals.slug |
string | |
proposals.name |
string | |
proposals.state |
any | |
proposals.reviews |
array of anys | Return serialized reviews based on user permissions and visibility settings. - Staff, call managers, and reviewers see all reviews. - Submitters see submitted reviews if visibility is enabled. |
proposals.approved_by_name |
string | |
proposals.created_by_name |
string | |
proposals.created |
string (date-time) |
List all reviewer suggestions for this call with affinity scores
List all reviewer suggestions for this call with affinity scores.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
- Model Source:
CallStates - Model Source:
ProtectedCallOEnum - API Source:
proposal_protected_calls_suggestions_list
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
customer |
string (uri) | |
customer_keyword |
string | |
customer_uuid |
string (uuid) | |
has_active_round |
boolean | |
name |
string | |
o |
array | Ordering |
offering_uuid |
string (uuid) | |
offerings_provider_uuid |
string (uuid) | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
state |
array |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
call |
string (uri) | |
call_uuid |
string (uuid) | |
call_name |
string | |
reviewer |
string (uri) | |
reviewer_uuid |
string (uuid) | |
reviewer_name |
string | |
reviewer_email |
string (email) | |
reviewer_biography |
string | Professional biography / summary |
affinity_score |
number (double) | Combined affinity score (0-1) |
keyword_score |
number (double) | Keyword matching score |
text_score |
number (double) | TF-IDF text similarity score |
status |
string | Enum: pending, confirmed, rejected, invited |
status_display |
string | |
reviewed_by |
string (uri) | |
reviewed_by_name |
string | |
reviewed_at |
string (date-time) | |
rejection_reason |
string | |
matched_keywords |
any | Keywords from reviewer's expertise that matched the source text |
top_matching_proposals |
any | Top proposals with highest affinity: [{uuid, name, slug, affinity}, ...] |
source_type |
any | What content was used to generate this suggestion |
source_type_display |
string | |
created |
string (date-time) |
Activate a call
Activate a call.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
proposal_protected_calls_activate
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
message |
string |
Archive a call
Archive a call.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
proposal_protected_calls_archive
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
message |
string |
Attach documents to call
Attach documents to call.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
CallAttachDocumentsRequest - API Source:
proposal_protected_calls_attach_documents
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
documents |
array of string (binary)s | ✓ |
description |
string |
200 - No response body
Compute affinity scores for all reviewer-proposal pairs
Compute affinity scores for all reviewer-proposal pairs.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
ProtectedCallRequest - API Source:
proposal_protected_calls_compute_affinities
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
slug |
string | URL-friendly identifier. Only editable by staff users. | |
name |
string | ✓ | |
description |
string | ||
manager |
string (uri) | ✓ | |
fixed_duration_in_days |
integer | ||
backend_id |
string | ||
external_url |
string (uri) | ||
reviewer_identity_visible_to_submitters |
boolean | Whether proposal applicants can see reviewer identities | |
reviews_visible_to_submitters |
boolean | Whether proposal applicants can see review comments and scores | |
created_by |
string (uri) | ||
reference_code |
string | ||
compliance_checklist |
string (uuid) | Compliance checklist that proposals must complete before submission | |
proposal_slug_template |
string | Template for proposal slugs. Supports: {call_slug}, {round_slug}, {org_slug}, {year}, {month}, {counter}, {counter_padded}. Default: {round_slug}-{counter_padded} | |
user_email_patterns |
any | List of email regex patterns. User must match one. | |
user_affiliations |
any | List of allowed affiliations. User must have one. | |
user_identity_sources |
any | List of allowed identity sources (identity providers). | |
user_nationalities |
any | List of allowed nationality codes (ISO 3166-1 alpha-2). User must have one. | |
user_organization_types |
any | List of allowed organization type URNs (SCHAC). User must match one. | |
user_assurance_levels |
any | List of required assurance URIs (REFEDS). User must have ALL of these. |
200 -
| Field | Type |
|---|---|
computed_count |
integer |
message |
string |
Detach documents from call
Detach documents from call.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
CallDetachDocumentsRequest - API Source:
proposal_protected_calls_detach_documents
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
documents |
array of string (uuid)s | ✓ |
200 - No response body
Trigger automated COI detection for all reviewer-proposal pairs
Trigger automated COI detection for all reviewer-proposal pairs.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
TriggerCOIDetectionRequest - API Source:
proposal_protected_calls_detect_conflicts
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
job_type |
any |
200 -
| Field | Type | Description |
|---|---|---|
url |
string | Return URL for the job detail endpoint. |
uuid |
string (uuid) | |
call |
string (uri) | |
call_uuid |
string (uuid) | |
call_name |
string | |
job_type |
any | |
state |
any | |
total_pairs |
integer | |
processed_pairs |
integer | |
progress_percentage |
number (double) | |
conflicts_found |
integer | |
started_at |
string (date-time) | |
completed_at |
string (date-time) | |
error_message |
string | |
created |
string (date-time) |
Generate assignments
Generate assignment batches for reviewers. Uses the affinity matrix and COI records to assign reviewers to proposals.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
GenerateAssignmentsRequest - API Source:
proposal_protected_calls_generate_assignments
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
proposal_uuids |
array of string (uuid)s | Specific proposal UUIDs to generate assignments for. If empty, generates for all submitted proposals needing reviewers. | |
reviewers_per_proposal |
integer | Number of reviewers to assign per proposal. If not specified, uses call's minimum_number_of_reviewers setting. |
200 -
| Field | Type | Description |
|---|---|---|
batches_created |
integer | |
items_created |
integer | |
proposals_processed |
integer | |
skipped_proposals |
array of objects | Proposals that were skipped with reasons |
Generate reviewer suggestions with configurable matching source
Generate reviewer suggestions with configurable matching source.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
GenerateSuggestionsRequestRequest - API Source:
proposal_protected_calls_generate_suggestions
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
source |
any | What content to match reviewers against Constraints: default: all_proposals |
|
proposal_uuids |
array of string (uuid)s | Specific proposal UUIDs to match against (for selected_proposals source) | |
keywords |
array of strings | Custom keywords to search for (for custom_keywords source) | |
keyword_search_mode |
any | How to search for custom keywords Constraints: default: expertise_only |
|
min_affinity_threshold |
number (double) | Minimum affinity score for suggestions (0.0-1.0) |
200 -
| Field | Type |
|---|---|
suggestions_created |
integer |
reviewers_evaluated |
integer |
source_used |
string |
suggestions |
array of strings |
Invite by email
Invite a reviewer by email address. Creates an invitation that requires the reviewer to create and publish a profile before accepting.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
EmailInvitationRequest - API Source:
proposal_protected_calls_invite_by_email
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
email |
string (email) | ✓ | Email address to send the invitation to |
invitation_message |
string | Custom message to include in invitation email | |
max_assignments |
integer | Constraints: default: 5 |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
call |
string (uri) | |
call_uuid |
string (uuid) | |
call_name |
string | |
reviewer |
string (uri) | |
reviewer_uuid |
string | Get reviewer profile UUID if available. |
reviewer_name |
string | Get reviewer name from profile or invited_user. |
reviewer_email |
string | Get email from profile, invited_user, or invited_email. |
has_profile |
boolean | Check if reviewer has a profile. |
invited_email |
string (email) | Email address for direct invitations |
invited_user |
string (uri) | Waldur user if email matches existing account |
invited_user_name |
string | |
invited_at |
string (date-time) | |
invitation_status |
any | |
invitation_status_display |
string | |
response_date |
string (date-time) | |
decline_reason |
string | |
max_assignments |
integer | |
current_assignments |
integer | |
expertise_match_score |
number (double) | Calculated affinity to call topics (0-1) |
invited_by_name |
string | |
invitation_token |
string | |
invitation_expires_at |
string (date-time) | |
created |
string (date-time) | |
coi_count |
integer | Count total COIs for this reviewer in this call. |
coi_by_severity |
object (free-form) | Count COIs by severity level. |
reviews_pending |
integer | Legacy field - always returns 0. Previously counted reviews in 'created' state, but that state has been removed. Reviews are now created directly in 'in_review' state. Kept for backwards compatibility with frontend. |
reviews_in_progress |
integer | Count reviews in 'in_review' state. |
reviews_completed |
integer | Count reviews in 'submitted' state. |
Invite reviewers to join the call's reviewer pool
Invite reviewers to join the call's reviewer pool.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 | |
- Model Source:
CallStates - Model Source:
ProtectedCallOEnum - Model Source:
ReviewerInvitationRequest - API Source:
proposal_protected_calls_invite_reviewers
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
customer |
string (uri) | |
customer_keyword |
string | |
customer_uuid |
string (uuid) | |
has_active_round |
boolean | |
name |
string | |
o |
array | Ordering |
offering_uuid |
string (uuid) | |
offerings_provider_uuid |
string (uuid) | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
state |
array |
| Field | Type | Required | Description |
|---|---|---|---|
reviewer_uuids |
array of string (uuid)s | ✓ | List of reviewer profile UUIDs to invite |
max_assignments |
integer | Constraints: default: 5 |
|
invitation_message |
string | Custom message to include in invitation email |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
call |
string (uri) | |
call_uuid |
string (uuid) | |
call_name |
string | |
reviewer |
string (uri) | |
reviewer_uuid |
string | Get reviewer profile UUID if available. |
reviewer_name |
string | Get reviewer name from profile or invited_user. |
reviewer_email |
string | Get email from profile, invited_user, or invited_email. |
has_profile |
boolean | Check if reviewer has a profile. |
invited_email |
string (email) | Email address for direct invitations |
invited_user |
string (uri) | Waldur user if email matches existing account |
invited_user_name |
string | |
invited_at |
string (date-time) | |
invitation_status |
any | |
invitation_status_display |
string | |
response_date |
string (date-time) | |
decline_reason |
string | |
max_assignments |
integer | |
current_assignments |
integer | |
expertise_match_score |
number (double) | Calculated affinity to call topics (0-1) |
invited_by_name |
string | |
invitation_token |
string | |
invitation_expires_at |
string (date-time) | |
created |
string (date-time) | |
coi_count |
integer | Count total COIs for this reviewer in this call. |
coi_by_severity |
object (free-form) | Count COIs by severity level. |
reviews_pending |
integer | Legacy field - always returns 0. Previously counted reviews in 'created' state, but that state has been removed. Reviews are now created directly in 'in_review' state. Kept for backwards compatibility with frontend. |
reviews_in_progress |
integer | Count reviews in 'in_review' state. |
reviews_completed |
integer | Count reviews in 'submitted' state. |
Create offering for a call
Create offering for a call.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
RequestedOfferingRequest - API Source:
proposal_protected_calls_offerings_set
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
offering |
string (uri) | ✓ |
attributes |
any | |
plan |
string (uri) | |
description |
string |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
state |
any | |
offering |
string (uri) | |
offering_name |
string | |
offering_uuid |
string (uuid) | |
provider_name |
string | |
category_uuid |
string (uuid) | |
category_name |
string | |
call_managing_organisation |
string | |
attributes |
any | |
plan |
string (uri) | |
plan_details |
any | |
options |
any | |
components |
array of objects | |
components.uuid |
string (uuid) | |
components.billing_type |
string | Enum: fixed, usage, limit, one, few |
components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
components.name |
string | Display name for the measured unit, for example, Floating IP. |
components.description |
string | |
components.measured_unit |
string | Unit of measurement, for example, GB. |
components.unit_factor |
integer | The conversion factor from backend units to measured_unit |
components.limit_period |
any | |
components.limit_amount |
integer | |
components.article_code |
string | |
components.max_value |
integer | |
components.min_value |
integer | |
components.max_available_limit |
integer | |
components.is_boolean |
boolean | |
components.default_limit |
integer | |
components.factor |
integer | |
components.is_builtin |
boolean | |
components.is_prepaid |
boolean | |
components.overage_component |
string (uuid) | |
components.min_prepaid_duration |
integer | |
components.max_prepaid_duration |
integer | |
created |
string (date-time) | |
url |
string | |
approved_by |
string (uri) | |
created_by |
string (uri) | |
created_by_name |
string | |
approved_by_name |
string | |
description |
string |
Create resource template for a call
Create resource template for a call.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
CallResourceTemplateRequest - API Source:
proposal_protected_calls_resource_templates_set
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ✓ | |
description |
string | ||
attributes |
any | ||
limits |
any | ||
is_required |
boolean | If True, every proposal must include this resource type | |
requested_offering |
string (uri) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string | |
name |
string | |
description |
string | |
attributes |
any | |
limits |
any | |
is_required |
boolean | If True, every proposal must include this resource type |
requested_offering |
string (uri) | |
requested_offering_name |
string | |
requested_offering_uuid |
string (uuid) | |
requested_offering_plan |
any | |
created_by |
string (uri) | |
created_by_name |
string | |
created |
string (date-time) |
Mark proposal compliance as reviewed by call manager
Mark proposal compliance as reviewed by call manager.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
CallComplianceReviewRequest - API Source:
proposal_protected_calls_review_proposal_compliance
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
proposal_uuid |
string (uuid) | ✓ |
review_notes |
string |
200 -
Close
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | |
- Model Source:
ProtectedCallRequest - API Source:
proposal_protected_calls_rounds_close
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
| Name | Type | Required |
|---|---|---|
obj_uuid |
string | ✓ |
uuid |
string | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
slug |
string | URL-friendly identifier. Only editable by staff users. | |
name |
string | ✓ | |
description |
string | ||
manager |
string (uri) | ✓ | |
fixed_duration_in_days |
integer | ||
backend_id |
string | ||
external_url |
string (uri) | ||
reviewer_identity_visible_to_submitters |
boolean | Whether proposal applicants can see reviewer identities | |
reviews_visible_to_submitters |
boolean | Whether proposal applicants can see review comments and scores | |
created_by |
string (uri) | ||
reference_code |
string | ||
compliance_checklist |
string (uuid) | Compliance checklist that proposals must complete before submission | |
proposal_slug_template |
string | Template for proposal slugs. Supports: {call_slug}, {round_slug}, {org_slug}, {year}, {month}, {counter}, {counter_padded}. Default: {round_slug}-{counter_padded} | |
user_email_patterns |
any | List of email regex patterns. User must match one. | |
user_affiliations |
any | List of allowed affiliations. User must have one. | |
user_identity_sources |
any | List of allowed identity sources (identity providers). | |
user_nationalities |
any | List of allowed nationality codes (ISO 3166-1 alpha-2). User must have one. | |
user_organization_types |
any | List of allowed organization type URNs (SCHAC). User must match one. | |
user_assurance_levels |
any | List of required assurance URIs (REFEDS). User must have ALL of these. |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
start_date |
string (date-time) | |
end_date |
string (date-time) | |
slug |
string | URL-friendly identifier. Only editable by staff users. |
name |
string | |
description |
string | |
state |
any | |
manager |
string (uri) | |
manager_uuid |
string (uuid) | |
customer_name |
string | |
customer_uuid |
string (uuid) | |
offerings |
array of objects | |
offerings.uuid |
string (uuid) | |
offerings.state |
any | |
offerings.offering |
string (uri) | |
offerings.offering_name |
string | |
offerings.offering_uuid |
string (uuid) | |
offerings.provider_name |
string | |
offerings.category_uuid |
string (uuid) | |
offerings.category_name |
string | |
offerings.call_managing_organisation |
string | |
offerings.attributes |
any | |
offerings.plan |
string (uri) | |
offerings.plan_details |
any | |
offerings.options |
any | |
offerings.components |
array of objects | |
offerings.components.uuid |
string (uuid) | |
offerings.components.billing_type |
string | Enum: fixed, usage, limit, one, few |
offerings.components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
offerings.components.name |
string | Display name for the measured unit, for example, Floating IP. |
offerings.components.description |
string | |
offerings.components.measured_unit |
string | Unit of measurement, for example, GB. |
offerings.components.unit_factor |
integer | The conversion factor from backend units to measured_unit |
offerings.components.limit_period |
any | |
offerings.components.limit_amount |
integer | |
offerings.components.article_code |
string | |
offerings.components.max_value |
integer | |
offerings.components.min_value |
integer | |
offerings.components.max_available_limit |
integer | |
offerings.components.is_boolean |
boolean | |
offerings.components.default_limit |
integer | |
offerings.components.factor |
integer | |
offerings.components.is_builtin |
boolean | |
offerings.components.is_prepaid |
boolean | |
offerings.components.overage_component |
string (uuid) | |
offerings.components.min_prepaid_duration |
integer | |
offerings.components.max_prepaid_duration |
integer | |
offerings.created |
string (date-time) | |
rounds |
array of objects | |
rounds.uuid |
string (uuid) | |
rounds.slug |
string | |
rounds.name |
string | |
rounds.start_time |
string (date-time) | |
rounds.cutoff_time |
string (date-time) | |
rounds.status |
any | |
rounds.review_strategy |
string | Enum: after_round, after_proposal |
rounds.deciding_entity |
string | Enum: by_call_manager, automatic |
rounds.allocation_time |
string | Enum: on_decision, fixed_date |
rounds.allocation_date |
string (date-time) | |
rounds.minimal_average_scoring |
string (decimal) | |
rounds.review_duration_in_days |
integer | |
rounds.minimum_number_of_reviewers |
integer | |
documents |
array of objects | |
documents.uuid |
string (uuid) | |
documents.file |
string (uri) | Documentation for call for proposals. |
documents.file_name |
string | |
documents.file_size |
integer | |
documents.description |
string | |
documents.created |
string (date-time) | |
resource_templates |
array of objects | |
resource_templates.uuid |
string (uuid) | |
resource_templates.url |
string | |
resource_templates.name |
string | |
resource_templates.description |
string | |
resource_templates.attributes |
any | |
resource_templates.limits |
any | |
resource_templates.is_required |
boolean | If True, every proposal must include this resource type |
resource_templates.requested_offering |
string (uri) | |
resource_templates.requested_offering_name |
string | |
resource_templates.requested_offering_uuid |
string (uuid) | |
resource_templates.requested_offering_plan |
any | |
resource_templates.created_by |
string (uri) | |
resource_templates.created_by_name |
string | |
resource_templates.created |
string (date-time) | |
fixed_duration_in_days |
integer | |
backend_id |
string | |
external_url |
string (uri) | |
reviewer_identity_visible_to_submitters |
boolean | Whether proposal applicants can see reviewer identities |
reviews_visible_to_submitters |
boolean | Whether proposal applicants can see review comments and scores |
has_eligibility_restrictions |
boolean | Check if call has any eligibility restrictions configured. |
created_by |
string (uri) | |
reference_code |
string | |
compliance_checklist |
string (uuid) | Compliance checklist that proposals must complete before submission |
compliance_checklist_name |
string | |
proposal_slug_template |
string | Template for proposal slugs. Supports: {call_slug}, {round_slug}, {org_slug}, {year}, {month}, {counter}, {counter_padded}. Default: {round_slug}-{counter_padded} |
user_email_patterns |
any | List of email regex patterns. User must match one. |
user_affiliations |
any | List of allowed affiliations. User must have one. |
user_identity_sources |
any | List of allowed identity sources (identity providers). |
user_nationalities |
any | List of allowed nationality codes (ISO 3166-1 alpha-2). User must have one. |
user_organization_types |
any | List of allowed organization type URNs (SCHAC). User must match one. |
user_assurance_levels |
any | List of required assurance URIs (REFEDS). User must have ALL of these. |
Create a round for a call
Create a round for a call.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
ProtectedRoundRequest - API Source:
proposal_protected_calls_rounds_set
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
start_time |
string (date-time) | ✓ |
cutoff_time |
string (date-time) | ✓ |
review_strategy |
string | |
deciding_entity |
string | |
allocation_time |
string | |
allocation_date |
string (date-time) | |
minimal_average_scoring |
string (decimal) | |
review_duration_in_days |
integer | |
minimum_number_of_reviewers |
integer |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
slug |
string | |
name |
string | |
start_time |
string (date-time) | |
cutoff_time |
string (date-time) | |
status |
any | |
review_strategy |
string | Enum: after_round, after_proposal |
deciding_entity |
string | Enum: by_call_manager, automatic |
allocation_time |
string | Enum: on_decision, fixed_date |
allocation_date |
string (date-time) | |
minimal_average_scoring |
string (decimal) | |
review_duration_in_days |
integer | |
minimum_number_of_reviewers |
integer | |
url |
string | |
proposals |
array of objects | |
proposals.uuid |
string (uuid) | |
proposals.slug |
string | |
proposals.name |
string | |
proposals.state |
any | |
proposals.reviews |
array of anys | Return serialized reviews based on user permissions and visibility settings. - Staff, call managers, and reviewers see all reviews. - Submitters see submitted reviews if visibility is enabled. |
proposals.approved_by_name |
string | |
proposals.created_by_name |
string | |
proposals.created |
string (date-time) |
Send all draft assignment batches for this call
Send all draft assignment batches for this call.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
SendAllAssignmentBatchesRequest - API Source:
proposal_protected_calls_send_all_assignments
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
batch_uuids |
array of string (uuid)s | Specific batch UUIDs to send. If empty, sends all draft batches. |
200 -
| Field | Type |
|---|---|
batches_sent |
integer |
skipped |
integer |
Send invitations to all confirmed suggestions
Send invitations to all confirmed suggestions.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
proposal_protected_calls_send_invitations
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
invitations_sent |
integer |
Update
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
RequestedOfferingRequest - API Source:
proposal_protected_calls_offerings_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
obj_uuid |
string | ✓ |
uuid |
string | ✓ |
| Field | Type | Required |
|---|---|---|
offering |
string (uri) | ✓ |
attributes |
any | |
plan |
string (uri) | |
description |
string |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
state |
any | |
offering |
string (uri) | |
offering_name |
string | |
offering_uuid |
string (uuid) | |
provider_name |
string | |
category_uuid |
string (uuid) | |
category_name |
string | |
call_managing_organisation |
string | |
attributes |
any | |
plan |
string (uri) | |
plan_details |
any | |
options |
any | |
components |
array of objects | |
components.uuid |
string (uuid) | |
components.billing_type |
string | Enum: fixed, usage, limit, one, few |
components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
components.name |
string | Display name for the measured unit, for example, Floating IP. |
components.description |
string | |
components.measured_unit |
string | Unit of measurement, for example, GB. |
components.unit_factor |
integer | The conversion factor from backend units to measured_unit |
components.limit_period |
any | |
components.limit_amount |
integer | |
components.article_code |
string | |
components.max_value |
integer | |
components.min_value |
integer | |
components.max_available_limit |
integer | |
components.is_boolean |
boolean | |
components.default_limit |
integer | |
components.factor |
integer | |
components.is_builtin |
boolean | |
components.is_prepaid |
boolean | |
components.overage_component |
string (uuid) | |
components.min_prepaid_duration |
integer | |
components.max_prepaid_duration |
integer | |
created |
string (date-time) | |
url |
string | |
approved_by |
string (uri) | |
created_by |
string (uri) | |
created_by_name |
string | |
approved_by_name |
string | |
description |
string |
Update
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | |
- Model Source:
CallResourceTemplateRequest - API Source:
proposal_protected_calls_resource_templates_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
| Name | Type | Required |
|---|---|---|
obj_uuid |
string | ✓ |
uuid |
string | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ✓ | |
description |
string | ||
attributes |
any | ||
limits |
any | ||
is_required |
boolean | If True, every proposal must include this resource type | |
requested_offering |
string (uri) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string | |
name |
string | |
description |
string | |
attributes |
any | |
limits |
any | |
is_required |
boolean | If True, every proposal must include this resource type |
requested_offering |
string (uri) | |
requested_offering_name |
string | |
requested_offering_uuid |
string (uuid) | |
requested_offering_plan |
any | |
created_by |
string (uri) | |
created_by_name |
string | |
created |
string (date-time) |
Update
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | |
- Model Source:
ProtectedRoundRequest - API Source:
proposal_protected_calls_rounds_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
| Name | Type | Required |
|---|---|---|
obj_uuid |
string | ✓ |
uuid |
string | ✓ |
| Field | Type | Required |
|---|---|---|
start_time |
string (date-time) | ✓ |
cutoff_time |
string (date-time) | ✓ |
review_strategy |
string | |
deciding_entity |
string | |
allocation_time |
string | |
allocation_date |
string (date-time) | |
minimal_average_scoring |
string (decimal) | |
review_duration_in_days |
integer | |
minimum_number_of_reviewers |
integer |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
slug |
string | |
name |
string | |
start_time |
string (date-time) | |
cutoff_time |
string (date-time) | |
status |
any | |
review_strategy |
string | Enum: after_round, after_proposal |
deciding_entity |
string | Enum: by_call_manager, automatic |
allocation_time |
string | Enum: on_decision, fixed_date |
allocation_date |
string (date-time) | |
minimal_average_scoring |
string (decimal) | |
review_duration_in_days |
integer | |
minimum_number_of_reviewers |
integer | |
url |
string | |
proposals |
array of objects | |
proposals.uuid |
string (uuid) | |
proposals.slug |
string | |
proposals.name |
string | |
proposals.state |
any | |
proposals.reviews |
array of anys | Return serialized reviews based on user permissions and visibility settings. - Staff, call managers, and reviewers see all reviews. - Submitters see submitted reviews if visibility is enabled. |
proposals.approved_by_name |
string | |
proposals.created_by_name |
string | |
proposals.created |
string (date-time) |
Get COI configuration for this call
Get COI configuration for this call.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedCallCOIConfigurationRequest - API Source:
proposal_protected_calls_coi_configuration_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
coauthorship_lookback_years |
integer | Years to look back for co-authorship detection | |
coauthorship_threshold_papers |
integer | Minimum shared papers to trigger COI | |
institutional_lookback_years |
integer | Years to look back for former institution detection | |
include_same_department |
boolean | Detect same-department as COI | |
include_same_institution |
boolean | Detect same-institution as COI | |
recusal_required_types |
array of strings | COI types requiring automatic recusal | |
management_allowed_types |
array of strings | COI types allowing management plan | |
disclosure_only_types |
array of strings | COI types requiring disclosure only | |
auto_detect_coauthorship |
boolean | Enable automated co-authorship detection | |
auto_detect_institutional |
boolean | Enable automated institutional affiliation detection | |
auto_detect_named_personnel |
boolean | Enable detection of reviewer named in proposals | |
invitation_proposal_disclosure |
any | Level of proposal information disclosed in reviewer invitations |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
call |
string (uri) | |
call_uuid |
string (uuid) | |
call_name |
string | |
coauthorship_lookback_years |
integer | Years to look back for co-authorship detection |
coauthorship_threshold_papers |
integer | Minimum shared papers to trigger COI |
institutional_lookback_years |
integer | Years to look back for former institution detection |
include_same_department |
boolean | Detect same-department as COI |
include_same_institution |
boolean | Detect same-institution as COI |
recusal_required_types |
array of strings | COI types requiring automatic recusal |
management_allowed_types |
array of strings | COI types allowing management plan |
disclosure_only_types |
array of strings | COI types requiring disclosure only |
auto_detect_coauthorship |
boolean | Enable automated co-authorship detection |
auto_detect_institutional |
boolean | Enable automated institutional affiliation detection |
auto_detect_named_personnel |
boolean | Enable detection of reviewer named in proposals |
invitation_proposal_disclosure |
any | Level of proposal information disclosed in reviewer invitations |
created |
string (date-time) | |
modified |
string (date-time) |
Get or update matching configuration for this call
Get or update matching configuration for this call.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedMatchingConfigurationRequest - API Source:
proposal_protected_calls_matching_configuration_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
affinity_method |
string | Enum: keyword, tfidf, combined |
|
keyword_weight |
number (double) | ||
text_weight |
number (double) | ||
min_reviewers_per_proposal |
integer | ||
max_reviewers_per_proposal |
integer | ||
min_proposals_per_reviewer |
integer | ||
max_proposals_per_reviewer |
integer | ||
algorithm |
string | Enum: minmax, fairflow, hungarian |
|
min_affinity_threshold |
number (double) | Minimum affinity score for FairFlow algorithm | |
use_reviewer_bids |
boolean | ||
bid_weight |
number (double) |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
call_uuid |
string (uuid) | |
call_name |
string | |
affinity_method |
string | Enum: keyword, tfidf, combined |
keyword_weight |
number (double) | |
text_weight |
number (double) | |
min_reviewers_per_proposal |
integer | |
max_reviewers_per_proposal |
integer | |
min_proposals_per_reviewer |
integer | |
max_proposals_per_reviewer |
integer | |
algorithm |
string | Enum: minmax, fairflow, hungarian |
min_affinity_threshold |
number (double) | Minimum affinity score for FairFlow algorithm |
use_reviewer_bids |
boolean | |
bid_weight |
number (double) | |
created |
string (date-time) | |
modified |
string (date-time) |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
- Model Source:
PatchedRequestedOfferingRequest - API Source:
proposal_protected_calls_offerings_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Name | Type | Required |
|---|---|---|
obj_uuid |
string | ✓ |
uuid |
string | ✓ |
| Field | Type | Required |
|---|---|---|
attributes |
any | |
plan |
string (uri) | |
description |
string |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
state |
any | |
offering |
string (uri) | |
offering_name |
string | |
offering_uuid |
string (uuid) | |
provider_name |
string | |
category_uuid |
string (uuid) | |
category_name |
string | |
call_managing_organisation |
string | |
attributes |
any | |
plan |
string (uri) | |
plan_details |
any | |
options |
any | |
components |
array of objects | |
components.uuid |
string (uuid) | |
components.billing_type |
string | Enum: fixed, usage, limit, one, few |
components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
components.name |
string | Display name for the measured unit, for example, Floating IP. |
components.description |
string | |
components.measured_unit |
string | Unit of measurement, for example, GB. |
components.unit_factor |
integer | The conversion factor from backend units to measured_unit |
components.limit_period |
any | |
components.limit_amount |
integer | |
components.article_code |
string | |
components.max_value |
integer | |
components.min_value |
integer | |
components.max_available_limit |
integer | |
components.is_boolean |
boolean | |
components.default_limit |
integer | |
components.factor |
integer | |
components.is_builtin |
boolean | |
components.is_prepaid |
boolean | |
components.overage_component |
string (uuid) | |
components.min_prepaid_duration |
integer | |
components.max_prepaid_duration |
integer | |
created |
string (date-time) | |
url |
string | |
approved_by |
string (uri) | |
created_by |
string (uri) | |
created_by_name |
string | |
approved_by_name |
string | |
description |
string |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
- Model Source:
PatchedCallResourceTemplateRequest - API Source:
proposal_protected_calls_resource_templates_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Name | Type | Required |
|---|---|---|
obj_uuid |
string | ✓ |
uuid |
string | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ||
description |
string | ||
attributes |
any | ||
limits |
any | ||
is_required |
boolean | If True, every proposal must include this resource type | |
requested_offering |
string (uri) |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string | |
name |
string | |
description |
string | |
attributes |
any | |
limits |
any | |
is_required |
boolean | If True, every proposal must include this resource type |
requested_offering |
string (uri) | |
requested_offering_name |
string | |
requested_offering_uuid |
string (uuid) | |
requested_offering_plan |
any | |
created_by |
string (uri) | |
created_by_name |
string | |
created |
string (date-time) |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
- Model Source:
PatchedProtectedRoundRequest - API Source:
proposal_protected_calls_rounds_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Name | Type | Required |
|---|---|---|
obj_uuid |
string | ✓ |
uuid |
string | ✓ |
| Field | Type | Required |
|---|---|---|
start_time |
string (date-time) | |
cutoff_time |
string (date-time) | |
review_strategy |
string | |
deciding_entity |
string | |
allocation_time |
string | |
allocation_date |
string (date-time) | |
minimal_average_scoring |
string (decimal) | |
review_duration_in_days |
integer | |
minimum_number_of_reviewers |
integer |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
slug |
string | |
name |
string | |
start_time |
string (date-time) | |
cutoff_time |
string (date-time) | |
status |
any | |
review_strategy |
string | Enum: after_round, after_proposal |
deciding_entity |
string | Enum: by_call_manager, automatic |
allocation_time |
string | Enum: on_decision, fixed_date |
allocation_date |
string (date-time) | |
minimal_average_scoring |
string (decimal) | |
review_duration_in_days |
integer | |
minimum_number_of_reviewers |
integer | |
url |
string | |
proposals |
array of objects | |
proposals.uuid |
string (uuid) | |
proposals.slug |
string | |
proposals.name |
string | |
proposals.state |
any | |
proposals.reviews |
array of anys | Return serialized reviews based on user permissions and visibility settings. - Staff, call managers, and reviewers see all reviews. - Submitters see submitted reviews if visibility is enabled. |
proposals.approved_by_name |
string | |
proposals.created_by_name |
string | |
proposals.created |
string (date-time) |
Delete custom applicant attribute config, reverting to system defaults
Delete custom applicant attribute config, reverting to system defaults.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- API Source:
proposal_protected_calls_offerings_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Name | Type | Required |
|---|---|---|
obj_uuid |
string | ✓ |
uuid |
string | ✓ |
204 - No response body
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Name | Type | Required |
|---|---|---|
obj_uuid |
string | ✓ |
uuid |
string | ✓ |
204 - No response body
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- API Source:
proposal_protected_calls_rounds_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Name | Type | Required |
|---|---|---|
obj_uuid |
string | ✓ |
uuid |
string | ✓ |
204 - No response body
Proposal Public Calls
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/proposal-public-calls/ |
List Proposal Public Calls |
| GET | /api/proposal-public-calls/{uuid}/ |
Retrieve |
| Other Actions | ||
| GET | /api/proposal-public-calls/{uuid}/check_eligibility/ |
Check if the current user is eligible to submit proposals to this call |
Core CRUD
List Proposal Public Calls
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
CallStates - Model Source:
ProtectedCallOEnum - Model Source:
PublicCallFieldEnum - API Source:
proposal_public_calls_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
customer |
string (uri) | |
customer_keyword |
string | |
customer_uuid |
string (uuid) | |
field |
array | |
has_active_round |
boolean | |
name |
string | |
o |
array | Ordering |
offering_uuid |
string (uuid) | |
offerings_provider_uuid |
string (uuid) | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
state |
array |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
start_date |
string (date-time) | |
end_date |
string (date-time) | |
slug |
string | URL-friendly identifier. Only editable by staff users. |
name |
string | |
description |
string | |
state |
any | |
manager |
string (uri) | |
manager_uuid |
string (uuid) | |
customer_name |
string | |
customer_uuid |
string (uuid) | |
offerings |
array of objects | |
offerings.uuid |
string (uuid) | |
offerings.state |
any | |
offerings.offering |
string (uri) | |
offerings.offering_name |
string | |
offerings.offering_uuid |
string (uuid) | |
offerings.provider_name |
string | |
offerings.category_uuid |
string (uuid) | |
offerings.category_name |
string | |
offerings.call_managing_organisation |
string | |
offerings.attributes |
any | |
offerings.plan |
string (uri) | |
offerings.plan_details |
any | |
offerings.options |
any | |
offerings.components |
array of objects | |
offerings.components.uuid |
string (uuid) | |
offerings.components.billing_type |
string | Enum: fixed, usage, limit, one, few |
offerings.components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
offerings.components.name |
string | Display name for the measured unit, for example, Floating IP. |
offerings.components.description |
string | |
offerings.components.measured_unit |
string | Unit of measurement, for example, GB. |
offerings.components.unit_factor |
integer | The conversion factor from backend units to measured_unit |
offerings.components.limit_period |
any | |
offerings.components.limit_amount |
integer | |
offerings.components.article_code |
string | |
offerings.components.max_value |
integer | |
offerings.components.min_value |
integer | |
offerings.components.max_available_limit |
integer | |
offerings.components.is_boolean |
boolean | |
offerings.components.default_limit |
integer | |
offerings.components.factor |
integer | |
offerings.components.is_builtin |
boolean | |
offerings.components.is_prepaid |
boolean | |
offerings.components.overage_component |
string (uuid) | |
offerings.components.min_prepaid_duration |
integer | |
offerings.components.max_prepaid_duration |
integer | |
offerings.created |
string (date-time) | |
rounds |
array of objects | |
rounds.uuid |
string (uuid) | |
rounds.slug |
string | |
rounds.name |
string | |
rounds.start_time |
string (date-time) | |
rounds.cutoff_time |
string (date-time) | |
rounds.status |
any | |
rounds.review_strategy |
string | Enum: after_round, after_proposal |
rounds.deciding_entity |
string | Enum: by_call_manager, automatic |
rounds.allocation_time |
string | Enum: on_decision, fixed_date |
rounds.allocation_date |
string (date-time) | |
rounds.minimal_average_scoring |
string (decimal) | |
rounds.review_duration_in_days |
integer | |
rounds.minimum_number_of_reviewers |
integer | |
documents |
array of objects | |
documents.uuid |
string (uuid) | |
documents.file |
string (uri) | Documentation for call for proposals. |
documents.file_name |
string | |
documents.file_size |
integer | |
documents.description |
string | |
documents.created |
string (date-time) | |
resource_templates |
array of objects | |
resource_templates.uuid |
string (uuid) | |
resource_templates.url |
string | |
resource_templates.name |
string | |
resource_templates.description |
string | |
resource_templates.attributes |
any | |
resource_templates.limits |
any | |
resource_templates.is_required |
boolean | If True, every proposal must include this resource type |
resource_templates.requested_offering |
string (uri) | |
resource_templates.requested_offering_name |
string | |
resource_templates.requested_offering_uuid |
string (uuid) | |
resource_templates.requested_offering_plan |
any | |
resource_templates.created_by |
string (uri) | |
resource_templates.created_by_name |
string | |
resource_templates.created |
string (date-time) | |
fixed_duration_in_days |
integer | Fixed duration in days that applies to all proposals in this call |
backend_id |
string | |
external_url |
string (uri) | |
reviewer_identity_visible_to_submitters |
boolean | Whether proposal applicants can see reviewer identities. If False, reviewers appear as 'Reviewer 1', 'Reviewer 2', etc. |
reviews_visible_to_submitters |
boolean | Whether proposal applicants can see review comments and scores. If False, applicants only see final approval/rejection status. |
has_eligibility_restrictions |
boolean | Check if call has any eligibility restrictions configured. |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
PublicCallFieldEnum - API Source:
proposal_public_calls_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
created |
string (date-time) | |
start_date |
string (date-time) | |
end_date |
string (date-time) | |
slug |
string | URL-friendly identifier. Only editable by staff users. |
name |
string | |
description |
string | |
state |
any | |
manager |
string (uri) | |
manager_uuid |
string (uuid) | |
customer_name |
string | |
customer_uuid |
string (uuid) | |
offerings |
array of objects | |
offerings.uuid |
string (uuid) | |
offerings.state |
any | |
offerings.offering |
string (uri) | |
offerings.offering_name |
string | |
offerings.offering_uuid |
string (uuid) | |
offerings.provider_name |
string | |
offerings.category_uuid |
string (uuid) | |
offerings.category_name |
string | |
offerings.call_managing_organisation |
string | |
offerings.attributes |
any | |
offerings.plan |
string (uri) | |
offerings.plan_details |
any | |
offerings.options |
any | |
offerings.components |
array of objects | |
offerings.components.uuid |
string (uuid) | |
offerings.components.billing_type |
string | Enum: fixed, usage, limit, one, few |
offerings.components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
offerings.components.name |
string | Display name for the measured unit, for example, Floating IP. |
offerings.components.description |
string | |
offerings.components.measured_unit |
string | Unit of measurement, for example, GB. |
offerings.components.unit_factor |
integer | The conversion factor from backend units to measured_unit |
offerings.components.limit_period |
any | |
offerings.components.limit_amount |
integer | |
offerings.components.article_code |
string | |
offerings.components.max_value |
integer | |
offerings.components.min_value |
integer | |
offerings.components.max_available_limit |
integer | |
offerings.components.is_boolean |
boolean | |
offerings.components.default_limit |
integer | |
offerings.components.factor |
integer | |
offerings.components.is_builtin |
boolean | |
offerings.components.is_prepaid |
boolean | |
offerings.components.overage_component |
string (uuid) | |
offerings.components.min_prepaid_duration |
integer | |
offerings.components.max_prepaid_duration |
integer | |
offerings.created |
string (date-time) | |
rounds |
array of objects | |
rounds.uuid |
string (uuid) | |
rounds.slug |
string | |
rounds.name |
string | |
rounds.start_time |
string (date-time) | |
rounds.cutoff_time |
string (date-time) | |
rounds.status |
any | |
rounds.review_strategy |
string | Enum: after_round, after_proposal |
rounds.deciding_entity |
string | Enum: by_call_manager, automatic |
rounds.allocation_time |
string | Enum: on_decision, fixed_date |
rounds.allocation_date |
string (date-time) | |
rounds.minimal_average_scoring |
string (decimal) | |
rounds.review_duration_in_days |
integer | |
rounds.minimum_number_of_reviewers |
integer | |
documents |
array of objects | |
documents.uuid |
string (uuid) | |
documents.file |
string (uri) | Documentation for call for proposals. |
documents.file_name |
string | |
documents.file_size |
integer | |
documents.description |
string | |
documents.created |
string (date-time) | |
resource_templates |
array of objects | |
resource_templates.uuid |
string (uuid) | |
resource_templates.url |
string | |
resource_templates.name |
string | |
resource_templates.description |
string | |
resource_templates.attributes |
any | |
resource_templates.limits |
any | |
resource_templates.is_required |
boolean | If True, every proposal must include this resource type |
resource_templates.requested_offering |
string (uri) | |
resource_templates.requested_offering_name |
string | |
resource_templates.requested_offering_uuid |
string (uuid) | |
resource_templates.requested_offering_plan |
any | |
resource_templates.created_by |
string (uri) | |
resource_templates.created_by_name |
string | |
resource_templates.created |
string (date-time) | |
fixed_duration_in_days |
integer | Fixed duration in days that applies to all proposals in this call |
backend_id |
string | |
external_url |
string (uri) | |
reviewer_identity_visible_to_submitters |
boolean | Whether proposal applicants can see reviewer identities. If False, reviewers appear as 'Reviewer 1', 'Reviewer 2', etc. |
reviews_visible_to_submitters |
boolean | Whether proposal applicants can see review comments and scores. If False, applicants only see final approval/rejection status. |
has_eligibility_restrictions |
boolean | Check if call has any eligibility restrictions configured. |
Other Actions
Check if the current user is eligible to submit proposals to this call
Check if the current user is eligible to submit proposals to this call.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
proposal_public_calls_check_eligibility_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
is_eligible |
boolean |
restrictions |
array of strings |
Call Reviewer Pools
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/call-reviewer-pools/ |
List Call Reviewer Pools |
| GET | /api/call-reviewer-pools/{uuid}/ |
Retrieve |
| PATCH | /api/call-reviewer-pools/{uuid}/ |
Partial Update |
| Other Actions | ||
| POST | /api/call-reviewer-pools/{uuid}/accept/ |
Accept a pool invitation (authenticated users only) |
| POST | /api/call-reviewer-pools/{uuid}/decline/ |
Decline a pool invitation (authenticated users only) |
Core CRUD
List Call Reviewer Pools
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- Model Source:
CallReviewerPoolOEnum - Model Source:
InvitationStatusEnum - API Source:
call_reviewer_pools_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
call_uuid |
string (uuid) | |
invitation_status |
array | |
my_invitations |
boolean | |
o |
array | Ordering |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
reviewer_uuid |
string (uuid) |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
call |
string (uri) | |
call_uuid |
string (uuid) | |
call_name |
string | |
reviewer |
string (uri) | |
reviewer_uuid |
string | Get reviewer profile UUID if available. |
reviewer_name |
string | Get reviewer name from profile or invited_user. |
reviewer_email |
string | Get email from profile, invited_user, or invited_email. |
has_profile |
boolean | Check if reviewer has a profile. |
invited_email |
string (email) | Email address for direct invitations |
invited_user |
string (uri) | Waldur user if email matches existing account |
invited_user_name |
string | |
invited_at |
string (date-time) | |
invitation_status |
any | |
invitation_status_display |
string | |
response_date |
string (date-time) | |
decline_reason |
string | |
max_assignments |
integer | |
current_assignments |
integer | |
expertise_match_score |
number (double) | Calculated affinity to call topics (0-1) |
invited_by_name |
string | |
invitation_token |
string | |
invitation_expires_at |
string (date-time) | |
created |
string (date-time) | |
coi_count |
integer | Count total COIs for this reviewer in this call. |
coi_by_severity |
object (free-form) | Count COIs by severity level. |
reviews_pending |
integer | Legacy field - always returns 0. Previously counted reviews in 'created' state, but that state has been removed. Reviews are now created directly in 'in_review' state. Kept for backwards compatibility with frontend. |
reviews_in_progress |
integer | Count reviews in 'in_review' state. |
reviews_completed |
integer | Count reviews in 'submitted' state. |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
call_reviewer_pools_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
call |
string (uri) | |
call_uuid |
string (uuid) | |
call_name |
string | |
reviewer |
string (uri) | |
reviewer_uuid |
string | Get reviewer profile UUID if available. |
reviewer_name |
string | Get reviewer name from profile or invited_user. |
reviewer_email |
string | Get email from profile, invited_user, or invited_email. |
has_profile |
boolean | Check if reviewer has a profile. |
invited_email |
string (email) | Email address for direct invitations |
invited_user |
string (uri) | Waldur user if email matches existing account |
invited_user_name |
string | |
invited_at |
string (date-time) | |
invitation_status |
any | |
invitation_status_display |
string | |
response_date |
string (date-time) | |
decline_reason |
string | |
max_assignments |
integer | |
current_assignments |
integer | |
expertise_match_score |
number (double) | Calculated affinity to call topics (0-1) |
invited_by_name |
string | |
invitation_token |
string | |
invitation_expires_at |
string (date-time) | |
created |
string (date-time) | |
coi_count |
integer | Count total COIs for this reviewer in this call. |
coi_by_severity |
object (free-form) | Count COIs by severity level. |
reviews_pending |
integer | Legacy field - always returns 0. Previously counted reviews in 'created' state, but that state has been removed. Reviews are now created directly in 'in_review' state. Kept for backwards compatibility with frontend. |
reviews_in_progress |
integer | Count reviews in 'in_review' state. |
reviews_completed |
integer | Count reviews in 'submitted' state. |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedCallReviewerPoolUpdateRequest - API Source:
call_reviewer_pools_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
max_assignments |
integer | Maximum number of proposals that can be assigned to this reviewer |
200 -
| Field | Type | Description |
|---|---|---|
max_assignments |
integer | Maximum number of proposals that can be assigned to this reviewer |
Other Actions
Accept a pool invitation (authenticated users only)
Accept a pool invitation (authenticated users only).
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
call_reviewer_pools_accept
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
The request body is an array of objects, where each object has the following structure:
| Field | Type | Required |
|---|---|---|
proposal_uuid |
string (uuid) | ✓ |
coi_type |
string | ✓ |
severity |
any | |
description |
string |
200 -
| Field | Type | Description |
|---|---|---|
detail |
string | |
declared_conflicts |
array of string (uuid)s | UUIDs of created conflict records |
400 -
| Field | Type |
|---|---|
error |
string |
message |
string |
profile_url |
string |
Decline a pool invitation (authenticated users only)
Decline a pool invitation (authenticated users only).
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
InvitationDeclineRequest - API Source:
call_reviewer_pools_decline
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
reason |
string | ✓ | Reason for declining the invitation |
200 -
| Field | Type |
|---|---|
detail |
string |
Call Rounds
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/call-rounds/ |
List Call Rounds |
| GET | /api/call-rounds/{uuid}/ |
Retrieve |
| Other Actions | ||
| GET | /api/call-rounds/{uuid}/reviewers/ |
Return list of reviewers for round |
Core CRUD
List Call Rounds
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
call_rounds_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
slug |
string |
start_time |
string (date-time) |
cutoff_time |
string (date-time) |
call_uuid |
string (uuid) |
call_name |
string |
status |
any |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
call_rounds_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
slug |
string |
start_time |
string (date-time) |
cutoff_time |
string (date-time) |
call_uuid |
string (uuid) |
call_name |
string |
status |
any |
Other Actions
Return list of reviewers for round
Return list of reviewers for round.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- API Source:
call_rounds_reviewers_list
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
full_name |
string |
email |
string (email) |
accepted_proposals |
integer |
rejected_proposals |
integer |
in_review_proposals |
integer |
Proposals
Assignment Batches
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/assignment-batches/ |
List Assignment Batches |
| GET | /api/assignment-batches/{uuid}/ |
Retrieve |
| POST | /api/assignment-batches/ |
Create |
| PUT | /api/assignment-batches/{uuid}/ |
Update |
| PATCH | /api/assignment-batches/{uuid}/ |
Partial Update |
| DELETE | /api/assignment-batches/{uuid}/ |
Delete |
| Other Actions | ||
| POST | /api/assignment-batches/{uuid}/cancel/ |
Cancel this assignment batch |
| POST | /api/assignment-batches/{uuid}/extend-deadline/ |
Extend deadline |
| POST | /api/assignment-batches/{uuid}/send/ |
Send this assignment batch invitation to the reviewer |
Core CRUD
List Assignment Batches
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
AssignmentBatchListOEnum - Model Source:
AssignmentBatchStatus - Model Source:
AssignmentSource - API Source:
assignment_batches_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
call_uuid |
string (uuid) | |
o |
array | Ordering |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
reviewer_pool_entry_uuid |
string (uuid) | |
reviewer_uuid |
string (uuid) | |
sent_after |
string (date-time) | |
sent_before |
string (date-time) | |
source |
array | |
status |
array |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
call |
string (uri) | |
call_uuid |
string (uuid) | |
call_name |
string | |
reviewer_pool_entry |
string (uri) | |
reviewer_pool_entry_uuid |
string (uuid) | |
reviewer_name |
string | Get reviewer name from pool entry. |
reviewer_email |
string | Get reviewer email from pool entry. |
reviewer_uuid |
string | Get reviewer profile UUID if available. |
status |
any | |
status_display |
string | |
sent_at |
string (date-time) | When the invitation was sent to the reviewer. |
expires_at |
string (date-time) | When the invitation expires. |
responded_at |
string (date-time) | When the reviewer completed their response. |
source |
any | |
source_display |
string | |
created_by |
string (uri) | User who created/approved this batch. |
created_by_name |
string | |
manager_notes |
string | Optional notes from call manager to reviewer. |
items_count |
integer | Total count of items in batch. |
items_pending_count |
integer | Count of pending items. |
items_accepted_count |
integer | Count of accepted items. |
items_declined_count |
integer | Count of declined items. |
is_expired |
boolean | |
created |
string (date-time) |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
assignment_batches_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
call |
string (uri) | |
call_uuid |
string (uuid) | |
call_name |
string | |
reviewer_pool_entry |
string (uri) | |
reviewer_pool_entry_uuid |
string (uuid) | |
reviewer_name |
string | Get reviewer name from pool entry. |
reviewer_email |
string | Get reviewer email from pool entry. |
reviewer_uuid |
string | Get reviewer profile UUID if available. |
status |
any | |
status_display |
string | |
sent_at |
string (date-time) | When the invitation was sent to the reviewer. |
expires_at |
string (date-time) | When the invitation expires. |
responded_at |
string (date-time) | When the reviewer completed their response. |
source |
any | |
source_display |
string | |
created_by |
string (uri) | User who created/approved this batch. |
created_by_name |
string | |
manager_notes |
string | Optional notes from call manager to reviewer. |
items |
array of objects | |
items.url |
string (uri) | |
items.uuid |
string (uuid) | |
items.batch |
string (uri) | |
items.proposal |
string (uri) | |
items.proposal_uuid |
string (uuid) | |
items.proposal_name |
string | |
items.proposal_slug |
string | |
items.status |
any | |
items.status_display |
string | |
items.affinity_score |
number (double) | Affinity score used for assignment (0-1). |
items.has_coi |
boolean | Whether COI was detected during pre-check. |
items.coi_count |
integer | Count of COI records blocking this assignment. |
items.responded_at |
string (date-time) | |
items.decline_reason |
string | Reason provided by reviewer for declining. |
items.review |
string (uri) | The Review record created when this assignment was accepted. |
items.review_uuid |
string (uuid) | |
items.reassign_count |
integer | Number of times this proposal has been reassigned. |
items.created |
string (date-time) | |
items_count |
integer | Total count of items in batch. |
items_pending_count |
integer | Count of pending items. |
items_accepted_count |
integer | Count of accepted items. |
items_declined_count |
integer | Count of declined items. |
is_expired |
boolean | |
created |
string (date-time) |
Create
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
- Model Source:
AssignmentBatchRequest - API Source:
assignment_batches_create
1 2 3 4 5 6 7 8 9 10 | |
| Field | Type | Required | Description |
|---|---|---|---|
manager_notes |
string | Optional notes from call manager to reviewer. |
201 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
call |
string (uri) | |
call_uuid |
string (uuid) | |
call_name |
string | |
reviewer_pool_entry |
string (uri) | |
reviewer_pool_entry_uuid |
string (uuid) | |
reviewer_name |
string | Get reviewer name from pool entry. |
reviewer_email |
string | Get reviewer email from pool entry. |
reviewer_uuid |
string | Get reviewer profile UUID if available. |
status |
any | |
status_display |
string | |
sent_at |
string (date-time) | When the invitation was sent to the reviewer. |
expires_at |
string (date-time) | When the invitation expires. |
responded_at |
string (date-time) | When the reviewer completed their response. |
source |
any | |
source_display |
string | |
created_by |
string (uri) | User who created/approved this batch. |
created_by_name |
string | |
manager_notes |
string | Optional notes from call manager to reviewer. |
items |
array of objects | |
items.url |
string (uri) | |
items.uuid |
string (uuid) | |
items.batch |
string (uri) | |
items.proposal |
string (uri) | |
items.proposal_uuid |
string (uuid) | |
items.proposal_name |
string | |
items.proposal_slug |
string | |
items.status |
any | |
items.status_display |
string | |
items.affinity_score |
number (double) | Affinity score used for assignment (0-1). |
items.has_coi |
boolean | Whether COI was detected during pre-check. |
items.coi_count |
integer | Count of COI records blocking this assignment. |
items.responded_at |
string (date-time) | |
items.decline_reason |
string | Reason provided by reviewer for declining. |
items.review |
string (uri) | The Review record created when this assignment was accepted. |
items.review_uuid |
string (uuid) | |
items.reassign_count |
integer | Number of times this proposal has been reassigned. |
items.created |
string (date-time) | |
items_count |
integer | Total count of items in batch. |
items_pending_count |
integer | Count of pending items. |
items_accepted_count |
integer | Count of accepted items. |
items_declined_count |
integer | Count of declined items. |
is_expired |
boolean | |
created |
string (date-time) |
Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
AssignmentBatchRequest - API Source:
assignment_batches_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
manager_notes |
string | Optional notes from call manager to reviewer. |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
call |
string (uri) | |
call_uuid |
string (uuid) | |
call_name |
string | |
reviewer_pool_entry |
string (uri) | |
reviewer_pool_entry_uuid |
string (uuid) | |
reviewer_name |
string | Get reviewer name from pool entry. |
reviewer_email |
string | Get reviewer email from pool entry. |
reviewer_uuid |
string | Get reviewer profile UUID if available. |
status |
any | |
status_display |
string | |
sent_at |
string (date-time) | When the invitation was sent to the reviewer. |
expires_at |
string (date-time) | When the invitation expires. |
responded_at |
string (date-time) | When the reviewer completed their response. |
source |
any | |
source_display |
string | |
created_by |
string (uri) | User who created/approved this batch. |
created_by_name |
string | |
manager_notes |
string | Optional notes from call manager to reviewer. |
items |
array of objects | |
items.url |
string (uri) | |
items.uuid |
string (uuid) | |
items.batch |
string (uri) | |
items.proposal |
string (uri) | |
items.proposal_uuid |
string (uuid) | |
items.proposal_name |
string | |
items.proposal_slug |
string | |
items.status |
any | |
items.status_display |
string | |
items.affinity_score |
number (double) | Affinity score used for assignment (0-1). |
items.has_coi |
boolean | Whether COI was detected during pre-check. |
items.coi_count |
integer | Count of COI records blocking this assignment. |
items.responded_at |
string (date-time) | |
items.decline_reason |
string | Reason provided by reviewer for declining. |
items.review |
string (uri) | The Review record created when this assignment was accepted. |
items.review_uuid |
string (uuid) | |
items.reassign_count |
integer | Number of times this proposal has been reassigned. |
items.created |
string (date-time) | |
items_count |
integer | Total count of items in batch. |
items_pending_count |
integer | Count of pending items. |
items_accepted_count |
integer | Count of accepted items. |
items_declined_count |
integer | Count of declined items. |
is_expired |
boolean | |
created |
string (date-time) |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedAssignmentBatchRequest - API Source:
assignment_batches_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
manager_notes |
string | Optional notes from call manager to reviewer. |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
call |
string (uri) | |
call_uuid |
string (uuid) | |
call_name |
string | |
reviewer_pool_entry |
string (uri) | |
reviewer_pool_entry_uuid |
string (uuid) | |
reviewer_name |
string | Get reviewer name from pool entry. |
reviewer_email |
string | Get reviewer email from pool entry. |
reviewer_uuid |
string | Get reviewer profile UUID if available. |
status |
any | |
status_display |
string | |
sent_at |
string (date-time) | When the invitation was sent to the reviewer. |
expires_at |
string (date-time) | When the invitation expires. |
responded_at |
string (date-time) | When the reviewer completed their response. |
source |
any | |
source_display |
string | |
created_by |
string (uri) | User who created/approved this batch. |
created_by_name |
string | |
manager_notes |
string | Optional notes from call manager to reviewer. |
items |
array of objects | |
items.url |
string (uri) | |
items.uuid |
string (uuid) | |
items.batch |
string (uri) | |
items.proposal |
string (uri) | |
items.proposal_uuid |
string (uuid) | |
items.proposal_name |
string | |
items.proposal_slug |
string | |
items.status |
any | |
items.status_display |
string | |
items.affinity_score |
number (double) | Affinity score used for assignment (0-1). |
items.has_coi |
boolean | Whether COI was detected during pre-check. |
items.coi_count |
integer | Count of COI records blocking this assignment. |
items.responded_at |
string (date-time) | |
items.decline_reason |
string | Reason provided by reviewer for declining. |
items.review |
string (uri) | The Review record created when this assignment was accepted. |
items.review_uuid |
string (uuid) | |
items.reassign_count |
integer | Number of times this proposal has been reassigned. |
items.created |
string (date-time) | |
items_count |
integer | Total count of items in batch. |
items_pending_count |
integer | Count of pending items. |
items_accepted_count |
integer | Count of accepted items. |
items_declined_count |
integer | Count of declined items. |
is_expired |
boolean | |
created |
string (date-time) |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
assignment_batches_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
Cancel this assignment batch
Cancel this assignment batch.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
assignment_batches_cancel
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
message |
string |
Extend deadline
Extend or modify the expiration date for an assignment batch. Can reactivate expired batches by setting a future deadline.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
ExtendDeadlineRequestRequest - API Source:
assignment_batches_extend_deadline
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
expires_at |
string (date-time) | ✓ | New expiration date and time for the assignment batch. |
200 -
| Field | Type | Description |
|---|---|---|
expires_at |
string (date-time) | The updated expiration date. |
status |
string | Current status of the batch. |
Send this assignment batch invitation to the reviewer
Send this assignment batch invitation to the reviewer.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
SendAssignmentBatchRequest - API Source:
assignment_batches_send
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
manager_notes |
string | Optional notes to include in the invitation email |
200 -
| Field | Type |
|---|---|
detail |
string |
expires_at |
string (date-time) |
Assignment Items
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/assignment-items/ |
List Assignment Items |
| GET | /api/assignment-items/{uuid}/ |
Retrieve |
| POST | /api/assignment-items/ |
Create |
| PUT | /api/assignment-items/{uuid}/ |
Update |
| PATCH | /api/assignment-items/{uuid}/ |
Partial Update |
| DELETE | /api/assignment-items/{uuid}/ |
Delete |
| Other Actions | ||
| GET | /api/assignment-items/{uuid}/suggest_alternatives/ |
Suggest alternative reviewers for a declined assignment |
| POST | /api/assignment-items/{uuid}/accept/ |
Accept this assignment item. Creates a Review record |
| POST | /api/assignment-items/{uuid}/decline/ |
Decline this assignment item |
| POST | /api/assignment-items/{uuid}/reassign/ |
Reassign this item to a different reviewer |
Core CRUD
List Assignment Items
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- Model Source:
AssignmentItemOEnum - Model Source:
AssignmentItemStatus - API Source:
assignment_items_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
batch_uuid |
string (uuid) | |
call_uuid |
string (uuid) | |
has_coi |
boolean | |
min_affinity_score |
number (float) | |
o |
array | Ordering |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
proposal_uuid |
string (uuid) | |
reviewer_uuid |
string (uuid) | |
status |
array |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
batch |
string (uri) | |
proposal |
string (uri) | |
proposal_uuid |
string (uuid) | |
proposal_name |
string | |
proposal_slug |
string | |
status |
any | |
status_display |
string | |
affinity_score |
number (double) | Affinity score used for assignment (0-1). |
has_coi |
boolean | Whether COI was detected during pre-check. |
coi_count |
integer | Count of COI records blocking this assignment. |
responded_at |
string (date-time) | |
decline_reason |
string | Reason provided by reviewer for declining. |
review |
string (uri) | The Review record created when this assignment was accepted. |
review_uuid |
string (uuid) | |
reassign_count |
integer | Number of times this proposal has been reassigned. |
created |
string (date-time) |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
assignment_items_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
batch |
string (uri) | |
proposal |
string (uri) | |
proposal_uuid |
string (uuid) | |
proposal_name |
string | |
proposal_slug |
string | |
status |
any | |
status_display |
string | |
affinity_score |
number (double) | Affinity score used for assignment (0-1). |
has_coi |
boolean | Whether COI was detected during pre-check. |
coi_count |
integer | Count of COI records blocking this assignment. |
responded_at |
string (date-time) | |
decline_reason |
string | Reason provided by reviewer for declining. |
review |
string (uri) | The Review record created when this assignment was accepted. |
review_uuid |
string (uuid) | |
reassign_count |
integer | Number of times this proposal has been reassigned. |
created |
string (date-time) |
Create
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
- Model Source:
AssignmentItemRequest - API Source:
assignment_items_create
1 2 3 4 5 6 7 8 9 10 | |
| Field | Type | Required | Description |
|---|---|---|---|
decline_reason |
string | Reason provided by reviewer for declining. |
201 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
batch |
string (uri) | |
proposal |
string (uri) | |
proposal_uuid |
string (uuid) | |
proposal_name |
string | |
proposal_slug |
string | |
status |
any | |
status_display |
string | |
affinity_score |
number (double) | Affinity score used for assignment (0-1). |
has_coi |
boolean | Whether COI was detected during pre-check. |
coi_count |
integer | Count of COI records blocking this assignment. |
responded_at |
string (date-time) | |
decline_reason |
string | Reason provided by reviewer for declining. |
review |
string (uri) | The Review record created when this assignment was accepted. |
review_uuid |
string (uuid) | |
reassign_count |
integer | Number of times this proposal has been reassigned. |
created |
string (date-time) |
Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
AssignmentItemRequest - API Source:
assignment_items_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
decline_reason |
string | Reason provided by reviewer for declining. |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
batch |
string (uri) | |
proposal |
string (uri) | |
proposal_uuid |
string (uuid) | |
proposal_name |
string | |
proposal_slug |
string | |
status |
any | |
status_display |
string | |
affinity_score |
number (double) | Affinity score used for assignment (0-1). |
has_coi |
boolean | Whether COI was detected during pre-check. |
coi_count |
integer | Count of COI records blocking this assignment. |
responded_at |
string (date-time) | |
decline_reason |
string | Reason provided by reviewer for declining. |
review |
string (uri) | The Review record created when this assignment was accepted. |
review_uuid |
string (uuid) | |
reassign_count |
integer | Number of times this proposal has been reassigned. |
created |
string (date-time) |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedAssignmentItemRequest - API Source:
assignment_items_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
decline_reason |
string | Reason provided by reviewer for declining. |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
batch |
string (uri) | |
proposal |
string (uri) | |
proposal_uuid |
string (uuid) | |
proposal_name |
string | |
proposal_slug |
string | |
status |
any | |
status_display |
string | |
affinity_score |
number (double) | Affinity score used for assignment (0-1). |
has_coi |
boolean | Whether COI was detected during pre-check. |
coi_count |
integer | Count of COI records blocking this assignment. |
responded_at |
string (date-time) | |
decline_reason |
string | Reason provided by reviewer for declining. |
review |
string (uri) | The Review record created when this assignment was accepted. |
review_uuid |
string (uuid) | |
reassign_count |
integer | Number of times this proposal has been reassigned. |
created |
string (date-time) |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
assignment_items_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
Suggest alternative reviewers for a declined assignment
Suggest alternative reviewers for a declined assignment.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
assignment_items_suggest_alternatives_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
suggestions |
array of objects | List of alternative reviewers with affinity scores |
Accept this assignment item. Creates a Review record
Accept this assignment item. Creates a Review record.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
assignment_items_accept
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
detail |
string | |
review_uuid |
string (uuid) | UUID of created review (only on accept) |
Decline this assignment item
Decline this assignment item.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
AssignmentItemDeclineRequest - API Source:
assignment_items_decline
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
reason |
string | Reason for declining this assignment |
200 -
| Field | Type | Description |
|---|---|---|
detail |
string | |
review_uuid |
string (uuid) | UUID of created review (only on accept) |
Reassign this item to a different reviewer
Reassign this item to a different reviewer.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
ReassignItemRequest - API Source:
assignment_items_reassign
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
reviewer_pool_entry_uuid |
string (uuid) | ✓ | UUID of the pool entry for the new reviewer |
manager_notes |
string | Notes to include in the reassignment notification |
200 -
| Field | Type |
|---|---|
detail |
string |
new_item_uuid |
string (uuid) |
new_batch_uuid |
string (uuid) |
My Assignment Batches
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/my-assignment-batches/ |
List all pending assignment batches for the authenticated reviewer |
| GET | /api/my-assignment-batches/{uuid}/ |
Get details of a specific assignment batch with items |
List all pending assignment batches for the authenticated reviewer
List all pending assignment batches for the authenticated reviewer.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
my_assignment_batches_list
1 2 3 4 5 6 7 8 9 10 | |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
uuid |
string (uuid) |
call_uuid |
string (uuid) |
call_name |
string |
status |
string |
status_display |
string |
sent_at |
string (date-time) |
expires_at |
string (date-time) |
is_expired |
boolean |
items_count |
integer |
items_pending_count |
integer |
manager_notes |
string |
Get details of a specific assignment batch with items
Get details of a specific assignment batch with items.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
my_assignment_batches_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required | Description |
|---|---|---|---|
uuid |
string | ✓ | UUID of the assignment batch |
200 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
call_uuid |
string (uuid) |
call_name |
string |
status |
string |
status_display |
string |
sent_at |
string (date-time) |
expires_at |
string (date-time) |
is_expired |
boolean |
items_count |
integer |
items_pending_count |
integer |
manager_notes |
string |
items |
array of objects |
items.uuid |
string (uuid) |
items.proposal_uuid |
string (uuid) |
items.proposal_name |
string |
items.proposal_slug |
string |
items.proposal_summary |
string |
items.status |
string |
items.status_display |
string |
items.affinity_score |
number (double) |
items.has_coi |
boolean |
Proposal Proposals
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/proposal-proposals/ |
List Proposal Proposals |
| GET | /api/proposal-proposals/{uuid}/ |
Retrieve |
| POST | /api/proposal-proposals/ |
Create |
| POST | /api/proposal-proposals/{uuid}/update_project_details/ |
Update project details of a proposal |
| DELETE | /api/proposal-proposals/{uuid}/ |
Delete |
| Permissions & Users | ||
| GET | /api/proposal-proposals/{uuid}/list_users/ |
List users and their roles in a scope |
| POST | /api/proposal-proposals/{uuid}/add_user/ |
Grant a role to a user |
| POST | /api/proposal-proposals/{uuid}/delete_user/ |
Revoke a role from a user |
| POST | /api/proposal-proposals/{uuid}/update_user/ |
Update a user's role expiration |
| Other Actions | ||
| GET | /api/proposal-proposals/{uuid}/checklist/ |
Get checklist with questions and existing answers |
| GET | /api/proposal-proposals/{uuid}/checklist_review/ |
Checklist review |
| GET | /api/proposal-proposals/checklist-template/ |
Get checklist template for creating new objects |
| GET | /api/proposal-proposals/{uuid}/completion_review_status/ |
Get checklist completion status with review triggers (reviewers only) |
| GET | /api/proposal-proposals/{uuid}/completion_status/ |
Get checklist completion status |
| GET | /api/proposal-proposals/{uuid}/resources/ |
List resources for a proposal |
| GET | /api/proposal-proposals/{uuid}/resources/{obj_uuid}/ |
Retrieve |
| POST | /api/proposal-proposals/{uuid}/approve/ |
Approve a proposal |
| POST | /api/proposal-proposals/{uuid}/attach_document/ |
Attach document to proposal |
| POST | /api/proposal-proposals/{uuid}/detach_documents/ |
Detach documents from proposal |
| POST | /api/proposal-proposals/{uuid}/reject/ |
Reject a proposal |
| POST | /api/proposal-proposals/{uuid}/resources/ |
Create resource for a proposal |
| POST | /api/proposal-proposals/{uuid}/submit/ |
Submit a proposal |
| POST | /api/proposal-proposals/{uuid}/submit_answers/ |
Submit checklist answers |
| PUT | /api/proposal-proposals/{uuid}/resources/{obj_uuid}/ |
Update |
| PATCH | /api/proposal-proposals/{uuid}/resources/{obj_uuid}/ |
Partial Update |
| DELETE | /api/proposal-proposals/{uuid}/resources/{obj_uuid}/ |
Delete |
Core CRUD
List Proposal Proposals
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- Model Source:
ProposalOEnum - Model Source:
ProposalStates - API Source:
proposal_proposals_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
call_uuid |
string (uuid) | |
created_by_uuid |
string (uuid) | |
my_proposals |
boolean | |
name |
string | |
o |
array | Ordering |
organization_uuid |
string (uuid) | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
round |
string (uuid) | |
round_uuid |
string (uuid) | |
state |
array |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
slug |
string | |
name |
string | |
description |
string | |
project_name |
string | |
project_summary |
string | |
project_is_confidential |
boolean | |
project_has_civilian_purpose |
boolean | |
supporting_documentation |
array of objects | |
supporting_documentation.uuid |
string (uuid) | |
supporting_documentation.file |
string (uri) | Upload supporting documentation in PDF format. |
supporting_documentation.file_name |
string | |
supporting_documentation.file_size |
integer | |
supporting_documentation.created |
string (date-time) | |
state |
any | |
approved_by |
string (uri) | |
created_by |
string (uri) | |
created_by_name |
string | |
created_by_uuid |
string (uuid) | |
duration_in_days |
integer | Duration in days after provisioning of resources. |
project |
string (uri) | |
round |
any | |
call_uuid |
string (uuid) | |
call_name |
string | |
call_managing_organisation_uuid |
string (uuid) | |
oecd_fos_2007_code |
any | |
oecd_fos_2007_label |
string | |
allocation_comment |
string | |
created |
string (date-time) | |
compliance_status |
object (free-form) | |
can_submit |
object (free-form) |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
proposal_proposals_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
slug |
string | |
name |
string | |
description |
string | |
project_name |
string | |
project_summary |
string | |
project_is_confidential |
boolean | |
project_has_civilian_purpose |
boolean | |
supporting_documentation |
array of objects | |
supporting_documentation.uuid |
string (uuid) | |
supporting_documentation.file |
string (uri) | Upload supporting documentation in PDF format. |
supporting_documentation.file_name |
string | |
supporting_documentation.file_size |
integer | |
supporting_documentation.created |
string (date-time) | |
state |
any | |
approved_by |
string (uri) | |
created_by |
string (uri) | |
created_by_name |
string | |
created_by_uuid |
string (uuid) | |
duration_in_days |
integer | Duration in days after provisioning of resources. |
project |
string (uri) | |
round |
any | |
call_uuid |
string (uuid) | |
call_name |
string | |
call_managing_organisation_uuid |
string (uuid) | |
oecd_fos_2007_code |
any | |
oecd_fos_2007_label |
string | |
allocation_comment |
string | |
created |
string (date-time) | |
compliance_status |
object (free-form) | |
can_submit |
object (free-form) |
Create
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
ProposalRequest - API Source:
proposal_proposals_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ✓ | |
description |
string | ||
project_summary |
string | ||
project_is_confidential |
boolean | ||
project_has_civilian_purpose |
boolean | ||
duration_in_days |
integer | Duration in days after provisioning of resources. | |
round_uuid |
string (uuid) | ✓ | Constraints: write-only |
oecd_fos_2007_code |
any |
201 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
slug |
string | |
name |
string | |
description |
string | |
project_name |
string | |
project_summary |
string | |
project_is_confidential |
boolean | |
project_has_civilian_purpose |
boolean | |
supporting_documentation |
array of objects | |
supporting_documentation.uuid |
string (uuid) | |
supporting_documentation.file |
string (uri) | Upload supporting documentation in PDF format. |
supporting_documentation.file_name |
string | |
supporting_documentation.file_size |
integer | |
supporting_documentation.created |
string (date-time) | |
state |
any | |
approved_by |
string (uri) | |
created_by |
string (uri) | |
created_by_name |
string | |
created_by_uuid |
string (uuid) | |
duration_in_days |
integer | Duration in days after provisioning of resources. |
project |
string (uri) | |
round |
any | |
call_uuid |
string (uuid) | |
call_name |
string | |
call_managing_organisation_uuid |
string (uuid) | |
oecd_fos_2007_code |
any | |
oecd_fos_2007_label |
string | |
allocation_comment |
string | |
created |
string (date-time) | |
compliance_status |
object (free-form) | |
can_submit |
object (free-form) |
Update project details of a proposal
Update project details of a proposal.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
ProposalUpdateProjectDetailsRequest - API Source:
proposal_proposals_update_project_details
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ✓ | |
description |
string | ||
project_summary |
string | ||
project_is_confidential |
boolean | ||
project_has_civilian_purpose |
boolean | ||
duration_in_days |
integer | Duration in days after provisioning of resources. | |
oecd_fos_2007_code |
any |
200 - No response body
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
proposal_proposals_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Permissions & Users
List users and their roles in a scope
Retrieves a list of users who have a role within a specific scope (e.g., a project or an organization). The list can be filtered by user details or role.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
- Model Source:
UserRoleDetailsFieldEnum - Model Source:
UserRoleDetailsOEnum - API Source:
proposal_proposals_list_users_list
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
field |
array | Fields to include in response |
full_name |
string | User full name |
native_name |
string | User native name |
o |
array | Ordering fields |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
role |
string (uuid) | Role UUID or name |
search_string |
string | Search string for user |
user |
string (uuid) | User UUID |
user_slug |
string | User slug |
user_url |
string | User URL |
username |
string | User username |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
created |
string (date-time) | |
expiration_time |
string (date-time) | |
role_name |
string | |
role_uuid |
string (uuid) | |
user_email |
string (email) | |
user_full_name |
string | |
user_username |
string | Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters |
user_uuid |
string (uuid) | |
user_image |
string (uri) | |
created_by_full_name |
string | |
created_by_uuid |
string (uuid) |
Grant a role to a user
Assigns a specific role to a user within the current scope. An optional expiration time for the role can be set.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
UserRoleCreateRequest - API Source:
proposal_proposals_add_user
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
role |
string | ✓ |
user |
string (uuid) | ✓ |
expiration_time |
string (date-time) |
201 -
| Field | Type |
|---|---|
expiration_time |
string (date-time) |
400 - Validation error, for example when trying to add a user to a terminated project.
Revoke a role from a user
Removes a specific role from a user within the current scope. This effectively revokes their permissions associated with that role.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
UserRoleDeleteRequest - API Source:
proposal_proposals_delete_user
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
role |
string | ✓ |
user |
string (uuid) | ✓ |
expiration_time |
string (date-time) |
200 - Role revoked successfully.
Update a user's role expiration
Updates the expiration time for a user's existing role in the current scope. This is useful for extending or shortening the duration of a permission. To make a role permanent, set expiration_time to null.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
UserRoleUpdateRequest - API Source:
proposal_proposals_update_user
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
role |
string | ✓ |
user |
string (uuid) | ✓ |
expiration_time |
string (date-time) |
200 -
| Field | Type |
|---|---|
expiration_time |
string (date-time) |
Other Actions
Get checklist with questions and existing answers
Get checklist with questions and existing answers.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
proposal_proposals_checklist_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
include_all |
boolean | If true, returns all questions including hidden ones (for dynamic form visibility). Default: false. |
200 -
| Field | Type | Description |
|---|---|---|
checklist |
object (free-form) | |
completion |
object | |
completion.uuid |
string (uuid) | |
completion.is_completed |
boolean | Whether all required questions have been answered |
completion.completion_percentage |
number (double) | |
completion.unanswered_required_questions |
array of anys | |
completion.checklist_name |
string | |
completion.checklist_description |
string | |
completion.created |
string (date-time) | |
completion.modified |
string (date-time) | |
questions |
array of objects | |
questions.uuid |
string (uuid) | |
questions.description |
string | |
questions.user_guidance |
string | |
questions.question_type |
any | Type of question and expected answer format |
questions.required |
boolean | |
questions.order |
integer | |
questions.existing_answer |
object (free-form) | |
questions.question_options |
array of anys | |
questions.min_value |
string (decimal) | Minimum value allowed for NUMBER, YEAR, and RATING type questions |
questions.max_value |
string (decimal) | Maximum value allowed for NUMBER, YEAR, and RATING type questions |
questions.allowed_file_types |
any | List of allowed file extensions (e.g., ['.pdf', '.doc', '.docx']). If empty, all file types are allowed. |
questions.allowed_mime_types |
any | List of allowed MIME types (e.g., ['application/pdf', 'application/msword']). If empty, MIME type validation is not enforced. When both extensions and MIME types are specified, files must match both criteria for security. |
questions.max_file_size_mb |
integer | Maximum file size in megabytes. If not set, no size limit is enforced. |
questions.max_files_count |
integer | Maximum number of files allowed for MULTIPLE_FILES type questions. If not set, no count limit is enforced. |
questions.dependencies_info |
object (free-form) |
400 -
404 -
Checklist review
Get checklist with questions and existing answers including review logic (reviewers only).
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
proposal_proposals_checklist_review_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
checklist |
object (free-form) | |
completion |
object | |
completion.uuid |
string (uuid) | |
completion.is_completed |
boolean | Whether all required questions have been answered |
completion.completion_percentage |
number (double) | |
completion.unanswered_required_questions |
array of anys | |
completion.checklist_name |
string | |
completion.checklist_description |
string | |
completion.created |
string (date-time) | |
completion.modified |
string (date-time) | |
completion.requires_review |
boolean | Whether any answers triggered review requirements |
completion.reviewed_by |
integer | User who reviewed the checklist completion |
completion.reviewed_by_name |
string | |
completion.reviewed_at |
string (date-time) | |
completion.review_notes |
string | Notes from the reviewer |
completion.review_trigger_summary |
array of anys | |
questions |
array of objects | |
questions.uuid |
string (uuid) | |
questions.description |
string | |
questions.user_guidance |
string | |
questions.question_type |
any | Type of question and expected answer format |
questions.required |
boolean | |
questions.order |
integer | |
questions.existing_answer |
object (free-form) | |
questions.question_options |
array of anys | |
questions.min_value |
string (decimal) | Minimum value allowed for NUMBER, YEAR, and RATING type questions |
questions.max_value |
string (decimal) | Maximum value allowed for NUMBER, YEAR, and RATING type questions |
questions.allowed_file_types |
any | List of allowed file extensions (e.g., ['.pdf', '.doc', '.docx']). If empty, all file types are allowed. |
questions.allowed_mime_types |
any | List of allowed MIME types (e.g., ['application/pdf', 'application/msword']). If empty, MIME type validation is not enforced. When both extensions and MIME types are specified, files must match both criteria for security. |
questions.max_file_size_mb |
integer | Maximum file size in megabytes. If not set, no size limit is enforced. |
questions.max_files_count |
integer | Maximum number of files allowed for MULTIPLE_FILES type questions. If not set, no count limit is enforced. |
questions.dependencies_info |
object (free-form) | |
questions.operator |
any | |
questions.review_answer_value |
any | Answer value that trigger review. |
questions.always_requires_review |
boolean | This question always requires review regardless of answer |
400 -
404 -
Get checklist template for creating new objects
Get checklist template for creating new objects.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
proposal_proposals_checklist_template_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required | Description |
|---|---|---|---|
parent_uuid |
string (uuid) | ✓ | UUID of the parent object (e.g., customer UUID for new projects) |
200 -
| Field | Type | Description |
|---|---|---|
checklist |
object (free-form) | |
questions |
array of objects | |
questions.uuid |
string (uuid) | |
questions.required |
boolean | |
questions.description |
string | |
questions.user_guidance |
string | Additional guidance text visible to users when answering and reviewing |
questions.question_options |
array of objects | |
questions.question_options.uuid |
string (uuid) | |
questions.question_options.label |
string | |
questions.question_options.order |
integer | |
questions.question_type |
any | Type of question and expected answer format |
questions.order |
integer | |
questions.min_value |
string (decimal) | Minimum value allowed for NUMBER, YEAR, and RATING type questions |
questions.max_value |
string (decimal) | Maximum value allowed for NUMBER, YEAR, and RATING type questions |
questions.allowed_file_types |
any | List of allowed file extensions (e.g., ['.pdf', '.doc', '.docx']). If empty, all file types are allowed. |
questions.allowed_mime_types |
any | List of allowed MIME types (e.g., ['application/pdf', 'application/msword']). If empty, MIME type validation is not enforced. When both extensions and MIME types are specified, files must match both criteria for security. |
questions.max_file_size_mb |
integer | Maximum file size in megabytes. If not set, no size limit is enforced. |
questions.max_files_count |
integer | Maximum number of files allowed for MULTIPLE_FILES type questions. If not set, no count limit is enforced. |
questions.operator |
any | |
questions.review_answer_value |
any | Answer value that trigger review. |
questions.always_requires_review |
boolean | This question always requires review regardless of answer |
questions.guidance_answer_value |
any | Answer value that triggers display of user guidance. |
questions.guidance_operator |
any | Operator to use when comparing answer with guidance_answer_value |
questions.always_show_guidance |
boolean | Show user guidance always, regardless of answer. If False, guidance is conditional on answer matching guidance_answer_value with guidance_operator |
questions.dependency_logic_operator |
any | Defines how multiple dependencies are evaluated. AND: All dependencies must be satisfied. OR: At least one dependency must be satisfied. |
initial_visible_questions |
array of objects | |
initial_visible_questions.uuid |
string (uuid) | |
initial_visible_questions.required |
boolean | |
initial_visible_questions.description |
string | |
initial_visible_questions.user_guidance |
string | Additional guidance text visible to users when answering and reviewing |
initial_visible_questions.question_options |
array of objects | |
initial_visible_questions.question_options.uuid |
string (uuid) | |
initial_visible_questions.question_options.label |
string | |
initial_visible_questions.question_options.order |
integer | |
initial_visible_questions.question_type |
any | Type of question and expected answer format |
initial_visible_questions.order |
integer | |
initial_visible_questions.min_value |
string (decimal) | Minimum value allowed for NUMBER, YEAR, and RATING type questions |
initial_visible_questions.max_value |
string (decimal) | Maximum value allowed for NUMBER, YEAR, and RATING type questions |
initial_visible_questions.allowed_file_types |
any | List of allowed file extensions (e.g., ['.pdf', '.doc', '.docx']). If empty, all file types are allowed. |
initial_visible_questions.allowed_mime_types |
any | List of allowed MIME types (e.g., ['application/pdf', 'application/msword']). If empty, MIME type validation is not enforced. When both extensions and MIME types are specified, files must match both criteria for security. |
initial_visible_questions.max_file_size_mb |
integer | Maximum file size in megabytes. If not set, no size limit is enforced. |
initial_visible_questions.max_files_count |
integer | Maximum number of files allowed for MULTIPLE_FILES type questions. If not set, no count limit is enforced. |
initial_visible_questions.operator |
any | |
initial_visible_questions.review_answer_value |
any | Answer value that trigger review. |
initial_visible_questions.always_requires_review |
boolean | This question always requires review regardless of answer |
initial_visible_questions.guidance_answer_value |
any | Answer value that triggers display of user guidance. |
initial_visible_questions.guidance_operator |
any | Operator to use when comparing answer with guidance_answer_value |
initial_visible_questions.always_show_guidance |
boolean | Show user guidance always, regardless of answer. If False, guidance is conditional on answer matching guidance_answer_value with guidance_operator |
initial_visible_questions.dependency_logic_operator |
any | Defines how multiple dependencies are evaluated. AND: All dependencies must be satisfied. OR: At least one dependency must be satisfied. |
400 -
404 -
Get checklist completion status with review triggers (reviewers only)
Get checklist completion status with review triggers (reviewers only).
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
is_completed |
boolean | Whether all required questions have been answered |
completion_percentage |
number (double) | |
unanswered_required_questions |
array of anys | |
checklist_name |
string | |
checklist_description |
string | |
created |
string (date-time) | |
modified |
string (date-time) | |
requires_review |
boolean | Whether any answers triggered review requirements |
reviewed_by |
integer | User who reviewed the checklist completion |
reviewed_by_name |
string | |
reviewed_at |
string (date-time) | |
review_notes |
string | Notes from the reviewer |
review_trigger_summary |
array of anys |
400 -
404 -
Get checklist completion status
Get checklist completion status.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
proposal_proposals_completion_status_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
is_completed |
boolean | Whether all required questions have been answered |
completion_percentage |
number (double) | |
unanswered_required_questions |
array of anys | |
checklist_name |
string | |
checklist_description |
string | |
created |
string (date-time) | |
modified |
string (date-time) |
400 -
404 -
List resources for a proposal
List resources for a proposal.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- API Source:
proposal_proposals_resources_list
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
uuid |
string (uuid) |
url |
string |
requested_offering |
any |
resource |
string (uri) |
resource_name |
string |
call_resource_template |
string |
call_resource_template_name |
string |
attributes |
any |
limits |
any |
description |
string |
created_by |
string (uri) |
created_by_name |
string |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- API Source:
proposal_proposals_resources_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Name | Type | Required |
|---|---|---|
obj_uuid |
string | ✓ |
uuid |
string | ✓ |
200 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
url |
string |
requested_offering |
any |
resource |
string (uri) |
resource_name |
string |
call_resource_template |
string |
call_resource_template_name |
string |
attributes |
any |
limits |
any |
description |
string |
created_by |
string (uri) |
created_by_name |
string |
Approve a proposal
Approve a proposal.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
ProposalApproveRequest - API Source:
proposal_proposals_approve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
allocation_comment |
string |
200 - No response body
Attach document to proposal
Attach document to proposal.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
ProposalDocumentationRequest - API Source:
proposal_proposals_attach_document
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
file |
string (binary) | Upload supporting documentation in PDF format. |
200 - No response body
Detach documents from proposal
Detach documents from proposal.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
ProposalDetachDocumentsRequest - API Source:
proposal_proposals_detach_documents
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
documents |
array of string (uuid)s | ✓ |
200 - No response body
Reject a proposal
Reject a proposal.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
ProposalApproveRequest - API Source:
proposal_proposals_reject
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
allocation_comment |
string |
200 - No response body
Create resource for a proposal
Create resource for a proposal.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
RequestedResourceRequest - API Source:
proposal_proposals_resources_set
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
attributes |
any | |
limits |
any | |
description |
string | |
requested_offering_uuid |
string (uuid) | |
call_resource_template_uuid |
string (uuid) |
200 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
url |
string |
requested_offering |
any |
resource |
string (uri) |
resource_name |
string |
call_resource_template |
string |
call_resource_template_name |
string |
attributes |
any |
limits |
any |
description |
string |
created_by |
string (uri) |
created_by_name |
string |
Submit a proposal
Submit a proposal.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
proposal_proposals_submit
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - No response body
Submit checklist answers
Submit checklist answers.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
proposal_proposals_submit_answers
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
The request body is an array of objects, where each object has the following structure:
| Field | Type | Required |
|---|---|---|
question_uuid |
string (uuid) | ✓ |
answer_data |
any | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
detail |
string | |
completion |
object | |
completion.uuid |
string (uuid) | |
completion.is_completed |
boolean | Whether all required questions have been answered |
completion.completion_percentage |
number (double) | |
completion.unanswered_required_questions |
array of anys | |
completion.checklist_name |
string | |
completion.checklist_description |
string | |
completion.created |
string (date-time) | |
completion.modified |
string (date-time) | |
completion.requires_review |
boolean | Whether any answers triggered review requirements |
completion.reviewed_by |
integer | User who reviewed the checklist completion |
completion.reviewed_by_name |
string | |
completion.reviewed_at |
string (date-time) | |
completion.review_notes |
string | Notes from the reviewer |
completion.review_trigger_summary |
array of anys |
400 -
404 -
Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
- Model Source:
RequestedResourceRequest - API Source:
proposal_proposals_resources_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Name | Type | Required |
|---|---|---|
obj_uuid |
string | ✓ |
uuid |
string | ✓ |
| Field | Type | Required |
|---|---|---|
attributes |
any | |
limits |
any | |
description |
string | |
requested_offering_uuid |
string (uuid) | |
call_resource_template_uuid |
string (uuid) |
200 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
url |
string |
requested_offering |
any |
resource |
string (uri) |
resource_name |
string |
call_resource_template |
string |
call_resource_template_name |
string |
attributes |
any |
limits |
any |
description |
string |
created_by |
string (uri) |
created_by_name |
string |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
- Model Source:
PatchedRequestedResourceRequest - API Source:
proposal_proposals_resources_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Name | Type | Required |
|---|---|---|
obj_uuid |
string | ✓ |
uuid |
string | ✓ |
| Field | Type | Required |
|---|---|---|
attributes |
any | |
limits |
any | |
description |
string | |
requested_offering_uuid |
string (uuid) | |
call_resource_template_uuid |
string (uuid) |
200 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
url |
string |
requested_offering |
any |
resource |
string (uri) |
resource_name |
string |
call_resource_template |
string |
call_resource_template_name |
string |
attributes |
any |
limits |
any |
description |
string |
created_by |
string (uri) |
created_by_name |
string |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- API Source:
proposal_proposals_resources_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Name | Type | Required |
|---|---|---|
obj_uuid |
string | ✓ |
uuid |
string | ✓ |
204 - No response body
Proposal Requested Offerings
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/proposal-requested-offerings/ |
List Proposal Requested Offerings |
| GET | /api/proposal-requested-offerings/{uuid}/ |
Retrieve |
| Other Actions | ||
| POST | /api/proposal-requested-offerings/{uuid}/accept/ |
Accept a requested offering |
| POST | /api/proposal-requested-offerings/{uuid}/cancel/ |
Cancel a requested offering |
Core CRUD
List Proposal Requested Offerings
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- Model Source:
ProviderRequestedOfferingOEnum - Model Source:
RequestedOfferingStates - API Source:
proposal_requested_offerings_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
call |
string (uri) | Call |
call_uuid |
string (uuid) | |
o |
array | Ordering |
offering |
string (uri) | Offering |
offering_uuid |
string (uuid) | |
organization_uuid |
string (uuid) | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
provider_uuid |
string (uuid) | Provider |
state |
array |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
state |
any | |
offering |
string (uri) | |
offering_name |
string | |
offering_uuid |
string (uuid) | |
provider_name |
string | |
category_uuid |
string (uuid) | |
category_name |
string | |
call_managing_organisation |
string | |
attributes |
any | |
plan |
string (uri) | |
plan_details |
any | |
options |
any | |
components |
array of objects | |
components.uuid |
string (uuid) | |
components.billing_type |
string | Enum: fixed, usage, limit, one, few |
components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
components.name |
string | Display name for the measured unit, for example, Floating IP. |
components.description |
string | |
components.measured_unit |
string | Unit of measurement, for example, GB. |
components.unit_factor |
integer | The conversion factor from backend units to measured_unit |
components.limit_period |
any | |
components.limit_amount |
integer | |
components.article_code |
string | |
components.max_value |
integer | |
components.min_value |
integer | |
components.max_available_limit |
integer | |
components.is_boolean |
boolean | |
components.default_limit |
integer | |
components.factor |
integer | |
components.is_builtin |
boolean | |
components.is_prepaid |
boolean | |
components.overage_component |
string (uuid) | |
components.min_prepaid_duration |
integer | |
components.max_prepaid_duration |
integer | |
created |
string (date-time) | |
url |
string (uri) | |
call_name |
string | |
call |
string (uri) | |
description |
string | |
created_by_name |
string | |
created_by_email |
string (email) |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
proposal_requested_offerings_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
state |
any | |
offering |
string (uri) | |
offering_name |
string | |
offering_uuid |
string (uuid) | |
provider_name |
string | |
category_uuid |
string (uuid) | |
category_name |
string | |
call_managing_organisation |
string | |
attributes |
any | |
plan |
string (uri) | |
plan_details |
any | |
options |
any | |
components |
array of objects | |
components.uuid |
string (uuid) | |
components.billing_type |
string | Enum: fixed, usage, limit, one, few |
components.type |
string | Unique internal name of the measured unit, for example floating_ip. |
components.name |
string | Display name for the measured unit, for example, Floating IP. |
components.description |
string | |
components.measured_unit |
string | Unit of measurement, for example, GB. |
components.unit_factor |
integer | The conversion factor from backend units to measured_unit |
components.limit_period |
any | |
components.limit_amount |
integer | |
components.article_code |
string | |
components.max_value |
integer | |
components.min_value |
integer | |
components.max_available_limit |
integer | |
components.is_boolean |
boolean | |
components.default_limit |
integer | |
components.factor |
integer | |
components.is_builtin |
boolean | |
components.is_prepaid |
boolean | |
components.overage_component |
string (uuid) | |
components.min_prepaid_duration |
integer | |
components.max_prepaid_duration |
integer | |
created |
string (date-time) | |
url |
string (uri) | |
call_name |
string | |
call |
string (uri) | |
description |
string | |
created_by_name |
string | |
created_by_email |
string (email) |
Other Actions
Accept a requested offering
Accept a requested offering.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
proposal_requested_offerings_accept
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - No response body
Cancel a requested offering
Cancel a requested offering.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
proposal_requested_offerings_cancel
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - No response body
Proposal Requested Resources
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/proposal-requested-resources/ |
List Proposal Requested Resources |
| GET | /api/proposal-requested-resources/{uuid}/ |
Retrieve |
List Proposal Requested Resources
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 | |
- Model Source:
ProviderRequestedResourceOEnum - API Source:
proposal_requested_resources_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
created |
string (date-time) | |
o |
array | Ordering |
offering |
string (uri) | Offering |
offering_uuid |
string (uuid) | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
proposal |
string (uri) | Proposal |
proposal_uuid |
string (uuid) | |
resource |
string (uri) | Resource |
resource_uuid |
string (uuid) |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
uuid |
string (uuid) |
url |
string |
requested_offering |
any |
resource |
string (uri) |
resource_name |
string |
call_resource_template |
string |
call_resource_template_name |
string |
attributes |
any |
limits |
any |
description |
string |
created_by |
string (uri) |
created_by_name |
string |
proposal_name |
string |
proposal |
string (uri) |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
proposal_requested_resources_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
url |
string |
requested_offering |
any |
resource |
string (uri) |
resource_name |
string |
call_resource_template |
string |
call_resource_template_name |
string |
attributes |
any |
limits |
any |
description |
string |
created_by |
string (uri) |
created_by_name |
string |
proposal_name |
string |
proposal |
string (uri) |
Reviews
Coi Detection Jobs
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/coi-detection-jobs/ |
List Coi Detection Jobs |
| GET | /api/coi-detection-jobs/{uuid}/ |
Retrieve |
List Coi Detection Jobs
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
COIDetectionJobJobTypeEnum - Model Source:
COIDetectionJobOEnum - Model Source:
COIDetectionJobStateEnum - API Source:
coi_detection_jobs_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
call_uuid |
string (uuid) | |
job_type |
string | Enum: full_call, incremental, single_pair |
o |
array | Ordering |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
state |
array |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string | Return URL for the job detail endpoint. |
uuid |
string (uuid) | |
call |
string (uri) | |
call_uuid |
string (uuid) | |
call_name |
string | |
job_type |
any | |
state |
any | |
total_pairs |
integer | |
processed_pairs |
integer | |
progress_percentage |
number (double) | |
conflicts_found |
integer | |
started_at |
string (date-time) | |
completed_at |
string (date-time) | |
error_message |
string | |
created |
string (date-time) |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
coi_detection_jobs_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
url |
string | Return URL for the job detail endpoint. |
uuid |
string (uuid) | |
call |
string (uri) | |
call_uuid |
string (uuid) | |
call_name |
string | |
job_type |
any | |
state |
any | |
total_pairs |
integer | |
processed_pairs |
integer | |
progress_percentage |
number (double) | |
conflicts_found |
integer | |
started_at |
string (date-time) | |
completed_at |
string (date-time) | |
error_message |
string | |
created |
string (date-time) |
Coi Disclosures
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/coi-disclosures/ |
List Coi Disclosures |
| GET | /api/coi-disclosures/{uuid}/ |
Retrieve |
| POST | /api/coi-disclosures/ |
Create |
List Coi Disclosures
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 | |
- Model Source:
COIDisclosureFormOEnum - API Source:
coi_disclosures_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
call_uuid |
string (uuid) | |
certified |
boolean | |
is_current |
boolean | |
o |
array | Ordering |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
reviewer_uuid |
string (uuid) |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
reviewer |
string (uri) | |
reviewer_uuid |
string (uuid) | |
reviewer_name |
string | |
call |
string (uri) | Null for general annual disclosure |
call_uuid |
string (uuid) | |
call_name |
string | |
certified |
boolean | |
certification_date |
string (date-time) | |
certification_statement |
string | Legal text they agreed to |
has_financial_interests |
boolean | |
financial_interests |
array of objects | |
financial_interests.uuid |
string (uuid) | |
financial_interests.entity_name |
string | |
financial_interests.entity_type |
string | Enum: company, startup, nonprofit, government, other |
financial_interests.relationship_type |
string | Enum: employment, consulting, equity, board, royalties, gifts, other |
financial_interests.amount_range |
string | Enum: none, under_5k, 5k_10k, 10k_50k, over_50k |
financial_interests.is_ongoing |
boolean | |
financial_interests.description |
string | |
has_personal_relationships |
boolean | |
personal_relationships |
any | |
has_other_conflicts |
boolean | |
other_conflicts_description |
string | |
valid_until |
string (date) | Typically 1 year from certification |
is_current |
boolean | |
created |
string (date-time) |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
coi_disclosures_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
reviewer |
string (uri) | |
reviewer_uuid |
string (uuid) | |
reviewer_name |
string | |
call |
string (uri) | Null for general annual disclosure |
call_uuid |
string (uuid) | |
call_name |
string | |
certified |
boolean | |
certification_date |
string (date-time) | |
certification_statement |
string | Legal text they agreed to |
has_financial_interests |
boolean | |
financial_interests |
array of objects | |
financial_interests.uuid |
string (uuid) | |
financial_interests.entity_name |
string | |
financial_interests.entity_type |
string | Enum: company, startup, nonprofit, government, other |
financial_interests.relationship_type |
string | Enum: employment, consulting, equity, board, royalties, gifts, other |
financial_interests.amount_range |
string | Enum: none, under_5k, 5k_10k, 10k_50k, over_50k |
financial_interests.is_ongoing |
boolean | |
financial_interests.description |
string | |
has_personal_relationships |
boolean | |
personal_relationships |
any | |
has_other_conflicts |
boolean | |
other_conflicts_description |
string | |
valid_until |
string (date) | Typically 1 year from certification |
is_current |
boolean | |
created |
string (date-time) |
Create
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
- Model Source:
COIDisclosureFormRequest - API Source:
coi_disclosures_create
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Field | Type | Required | Description |
|---|---|---|---|
call |
string (uri) | Null for general annual disclosure | |
certified |
boolean | ||
certification_statement |
string | Legal text they agreed to | |
has_financial_interests |
boolean | ||
has_personal_relationships |
boolean | ||
personal_relationships |
any | ||
has_other_conflicts |
boolean | ||
other_conflicts_description |
string | ||
valid_until |
string (date) | ✓ | Typically 1 year from certification |
201 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
reviewer |
string (uri) | |
reviewer_uuid |
string (uuid) | |
reviewer_name |
string | |
call |
string (uri) | Null for general annual disclosure |
call_uuid |
string (uuid) | |
call_name |
string | |
certified |
boolean | |
certification_date |
string (date-time) | |
certification_statement |
string | Legal text they agreed to |
has_financial_interests |
boolean | |
financial_interests |
array of objects | |
financial_interests.uuid |
string (uuid) | |
financial_interests.entity_name |
string | |
financial_interests.entity_type |
string | Enum: company, startup, nonprofit, government, other |
financial_interests.relationship_type |
string | Enum: employment, consulting, equity, board, royalties, gifts, other |
financial_interests.amount_range |
string | Enum: none, under_5k, 5k_10k, 10k_50k, over_50k |
financial_interests.is_ongoing |
boolean | |
financial_interests.description |
string | |
has_personal_relationships |
boolean | |
personal_relationships |
any | |
has_other_conflicts |
boolean | |
other_conflicts_description |
string | |
valid_until |
string (date) | Typically 1 year from certification |
is_current |
boolean | |
created |
string (date-time) |
Conflicts Of Interest
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/conflicts-of-interest/ |
List Conflicts Of Interest |
| GET | /api/conflicts-of-interest/{uuid}/ |
Retrieve |
| PUT | /api/conflicts-of-interest/{uuid}/ |
Update |
| PATCH | /api/conflicts-of-interest/{uuid}/ |
Partial Update |
| Other Actions | ||
| POST | /api/conflicts-of-interest/{uuid}/dismiss/ |
Dismiss a conflict of interest (not a real conflict) |
| POST | /api/conflicts-of-interest/{uuid}/recuse/ |
Recuse reviewer from the proposal |
| POST | /api/conflicts-of-interest/{uuid}/waive/ |
Waive a conflict with a management plan |
Core CRUD
List Conflicts Of Interest
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
- Model Source:
COISeverityLevel - Model Source:
CoiTypeEnum - Model Source:
ConflictOfInterestOEnum - Model Source:
ConflictOfInterestStatusEnum - Model Source:
DetectionMethodEnum - API Source:
conflicts_of_interest_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
call_uuid |
string (uuid) | |
coi_type |
array | |
detection_method |
array | |
o |
array | Ordering |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
proposal_uuid |
string (uuid) | |
reviewer_name |
string | |
reviewer_uuid |
string (uuid) | |
round_uuid |
string (uuid) | |
severity |
string | Enum: real, apparent, potential |
status |
array |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
reviewer |
string (uri) | |
reviewer_uuid |
string (uuid) | |
reviewer_name |
string | |
proposal |
string (uri) | |
proposal_uuid |
string (uuid) | |
proposal_name |
string | |
round_uuid |
string (uuid) | |
round_name |
string | |
call |
string (uri) | |
call_uuid |
string (uuid) | |
call_name |
string | |
coi_type |
any | |
coi_type_display |
string | |
severity |
any | |
severity_display |
string | |
detection_method |
any | |
detected_at |
string (date-time) | |
evidence_description |
string | |
evidence_data |
any | Structured evidence: {"papers": [...], "affiliation_overlap": {...}} |
status |
string | Enum: pending, dismissed, waived, recused |
status_display |
string | |
reviewed_by |
string (uri) | |
reviewed_by_name |
string | |
reviewed_at |
string (date-time) | |
review_notes |
string | |
management_plan |
string | If waived, how is it managed |
conflicting_user |
string (uri) | Specific person causing conflict |
conflicting_user_name |
string | |
conflicting_organization |
string (uri) | |
conflicting_organization_name |
string | |
created |
string (date-time) |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
conflicts_of_interest_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
reviewer |
string (uri) | |
reviewer_uuid |
string (uuid) | |
reviewer_name |
string | |
proposal |
string (uri) | |
proposal_uuid |
string (uuid) | |
proposal_name |
string | |
round_uuid |
string (uuid) | |
round_name |
string | |
call |
string (uri) | |
call_uuid |
string (uuid) | |
call_name |
string | |
coi_type |
any | |
coi_type_display |
string | |
severity |
any | |
severity_display |
string | |
detection_method |
any | |
detected_at |
string (date-time) | |
evidence_description |
string | |
evidence_data |
any | Structured evidence: {"papers": [...], "affiliation_overlap": {...}} |
status |
string | Enum: pending, dismissed, waived, recused |
status_display |
string | |
reviewed_by |
string (uri) | |
reviewed_by_name |
string | |
reviewed_at |
string (date-time) | |
review_notes |
string | |
management_plan |
string | If waived, how is it managed |
conflicting_user |
string (uri) | Specific person causing conflict |
conflicting_user_name |
string | |
conflicting_organization |
string (uri) | |
conflicting_organization_name |
string | |
created |
string (date-time) |
Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
ConflictOfInterestRequest - API Source:
conflicts_of_interest_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
status |
string | Enum: pending, dismissed, waived, recused |
|
review_notes |
string | ||
management_plan |
string | If waived, how is it managed |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
reviewer |
string (uri) | |
reviewer_uuid |
string (uuid) | |
reviewer_name |
string | |
proposal |
string (uri) | |
proposal_uuid |
string (uuid) | |
proposal_name |
string | |
round_uuid |
string (uuid) | |
round_name |
string | |
call |
string (uri) | |
call_uuid |
string (uuid) | |
call_name |
string | |
coi_type |
any | |
coi_type_display |
string | |
severity |
any | |
severity_display |
string | |
detection_method |
any | |
detected_at |
string (date-time) | |
evidence_description |
string | |
evidence_data |
any | Structured evidence: {"papers": [...], "affiliation_overlap": {...}} |
status |
string | Enum: pending, dismissed, waived, recused |
status_display |
string | |
reviewed_by |
string (uri) | |
reviewed_by_name |
string | |
reviewed_at |
string (date-time) | |
review_notes |
string | |
management_plan |
string | If waived, how is it managed |
conflicting_user |
string (uri) | Specific person causing conflict |
conflicting_user_name |
string | |
conflicting_organization |
string (uri) | |
conflicting_organization_name |
string | |
created |
string (date-time) |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedConflictOfInterestRequest - API Source:
conflicts_of_interest_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
status |
string | Enum: pending, dismissed, waived, recused |
|
review_notes |
string | ||
management_plan |
string | If waived, how is it managed |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
reviewer |
string (uri) | |
reviewer_uuid |
string (uuid) | |
reviewer_name |
string | |
proposal |
string (uri) | |
proposal_uuid |
string (uuid) | |
proposal_name |
string | |
round_uuid |
string (uuid) | |
round_name |
string | |
call |
string (uri) | |
call_uuid |
string (uuid) | |
call_name |
string | |
coi_type |
any | |
coi_type_display |
string | |
severity |
any | |
severity_display |
string | |
detection_method |
any | |
detected_at |
string (date-time) | |
evidence_description |
string | |
evidence_data |
any | Structured evidence: {"papers": [...], "affiliation_overlap": {...}} |
status |
string | Enum: pending, dismissed, waived, recused |
status_display |
string | |
reviewed_by |
string (uri) | |
reviewed_by_name |
string | |
reviewed_at |
string (date-time) | |
review_notes |
string | |
management_plan |
string | If waived, how is it managed |
conflicting_user |
string (uri) | Specific person causing conflict |
conflicting_user_name |
string | |
conflicting_organization |
string (uri) | |
conflicting_organization_name |
string | |
created |
string (date-time) |
Other Actions
Dismiss a conflict of interest (not a real conflict)
Dismiss a conflict of interest (not a real conflict).
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
COIStatusUpdateRequest - API Source:
conflicts_of_interest_dismiss
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
status |
string | ✓ | Enum: dismissed, waived, recused |
review_notes |
string | ||
management_plan |
string | Required when status is 'waived' |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
reviewer |
string (uri) | |
reviewer_uuid |
string (uuid) | |
reviewer_name |
string | |
proposal |
string (uri) | |
proposal_uuid |
string (uuid) | |
proposal_name |
string | |
round_uuid |
string (uuid) | |
round_name |
string | |
call |
string (uri) | |
call_uuid |
string (uuid) | |
call_name |
string | |
coi_type |
any | |
coi_type_display |
string | |
severity |
any | |
severity_display |
string | |
detection_method |
any | |
detected_at |
string (date-time) | |
evidence_description |
string | |
evidence_data |
any | Structured evidence: {"papers": [...], "affiliation_overlap": {...}} |
status |
string | Enum: pending, dismissed, waived, recused |
status_display |
string | |
reviewed_by |
string (uri) | |
reviewed_by_name |
string | |
reviewed_at |
string (date-time) | |
review_notes |
string | |
management_plan |
string | If waived, how is it managed |
conflicting_user |
string (uri) | Specific person causing conflict |
conflicting_user_name |
string | |
conflicting_organization |
string (uri) | |
conflicting_organization_name |
string | |
created |
string (date-time) |
Recuse reviewer from the proposal
Recuse reviewer from the proposal.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
COIStatusUpdateRequest - API Source:
conflicts_of_interest_recuse
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
status |
string | ✓ | Enum: dismissed, waived, recused |
review_notes |
string | ||
management_plan |
string | Required when status is 'waived' |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
reviewer |
string (uri) | |
reviewer_uuid |
string (uuid) | |
reviewer_name |
string | |
proposal |
string (uri) | |
proposal_uuid |
string (uuid) | |
proposal_name |
string | |
round_uuid |
string (uuid) | |
round_name |
string | |
call |
string (uri) | |
call_uuid |
string (uuid) | |
call_name |
string | |
coi_type |
any | |
coi_type_display |
string | |
severity |
any | |
severity_display |
string | |
detection_method |
any | |
detected_at |
string (date-time) | |
evidence_description |
string | |
evidence_data |
any | Structured evidence: {"papers": [...], "affiliation_overlap": {...}} |
status |
string | Enum: pending, dismissed, waived, recused |
status_display |
string | |
reviewed_by |
string (uri) | |
reviewed_by_name |
string | |
reviewed_at |
string (date-time) | |
review_notes |
string | |
management_plan |
string | If waived, how is it managed |
conflicting_user |
string (uri) | Specific person causing conflict |
conflicting_user_name |
string | |
conflicting_organization |
string (uri) | |
conflicting_organization_name |
string | |
created |
string (date-time) |
Waive a conflict with a management plan
Waive a conflict with a management plan.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
COIStatusUpdateRequest - API Source:
conflicts_of_interest_waive
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
status |
string | ✓ | Enum: dismissed, waived, recused |
review_notes |
string | ||
management_plan |
string | Required when status is 'waived' |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
reviewer |
string (uri) | |
reviewer_uuid |
string (uuid) | |
reviewer_name |
string | |
proposal |
string (uri) | |
proposal_uuid |
string (uuid) | |
proposal_name |
string | |
round_uuid |
string (uuid) | |
round_name |
string | |
call |
string (uri) | |
call_uuid |
string (uuid) | |
call_name |
string | |
coi_type |
any | |
coi_type_display |
string | |
severity |
any | |
severity_display |
string | |
detection_method |
any | |
detected_at |
string (date-time) | |
evidence_description |
string | |
evidence_data |
any | Structured evidence: {"papers": [...], "affiliation_overlap": {...}} |
status |
string | Enum: pending, dismissed, waived, recused |
status_display |
string | |
reviewed_by |
string (uri) | |
reviewed_by_name |
string | |
reviewed_at |
string (date-time) | |
review_notes |
string | |
management_plan |
string | If waived, how is it managed |
conflicting_user |
string (uri) | Specific person causing conflict |
conflicting_user_name |
string | |
conflicting_organization |
string (uri) | |
conflicting_organization_name |
string | |
created |
string (date-time) |
Expertise Categories
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/expertise-categories/ |
List Expertise Categories |
| GET | /api/expertise-categories/{uuid}/ |
Retrieve |
List Expertise Categories
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 | |
- Model Source:
ExpertiseCategoryOEnum - API Source:
expertise_categories_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
code |
string | |
level |
integer | |
name |
string | |
o |
array | Ordering |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
parent_uuid |
string (uuid) |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
code |
string | |
description |
string | |
parent |
string (uri) | |
level |
integer | Depth in hierarchy (0 = root) |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
expertise_categories_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
code |
string | |
description |
string | |
parent |
string (uri) | |
level |
integer | Depth in hierarchy (0 = root) |
Reviewer Bids
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/reviewer-bids/ |
List Reviewer Bids |
| GET | /api/reviewer-bids/{uuid}/ |
Retrieve |
| POST | /api/reviewer-bids/ |
Create |
| PUT | /api/reviewer-bids/{uuid}/ |
Update |
| PATCH | /api/reviewer-bids/{uuid}/ |
Partial Update |
| DELETE | /api/reviewer-bids/{uuid}/ |
Delete |
| Other Actions | ||
| GET | /api/reviewer-bids/my-bids/ |
Get my bids for a specific call |
| POST | /api/reviewer-bids/bulk-submit/ |
Submit multiple bids at once |
| POST | /api/reviewer-bids/submit/ |
Submit a bid on a proposal |
Core CRUD
List Reviewer Bids
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- Model Source:
BidEnum - Model Source:
ReviewerBidOEnum - API Source:
reviewer_bids_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
bid |
array | Reviewer's preference for reviewing this proposal |
call_uuid |
string (uuid) | |
o |
array | Ordering |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
proposal_uuid |
string (uuid) | |
reviewer_uuid |
string (uuid) |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
call |
string (uri) | |
call_uuid |
string (uuid) | |
reviewer |
string (uri) | |
reviewer_uuid |
string (uuid) | |
reviewer_name |
string | |
proposal |
string (uri) | |
proposal_uuid |
string (uuid) | |
proposal_name |
string | |
bid |
any | Reviewer's preference for reviewing this proposal |
bid_display |
string | |
comment |
string | Optional comment explaining the bid |
submitted_at |
string (date-time) | |
modified_at |
string (date-time) |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
reviewer_bids_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
call |
string (uri) | |
call_uuid |
string (uuid) | |
reviewer |
string (uri) | |
reviewer_uuid |
string (uuid) | |
reviewer_name |
string | |
proposal |
string (uri) | |
proposal_uuid |
string (uuid) | |
proposal_name |
string | |
bid |
any | Reviewer's preference for reviewing this proposal |
bid_display |
string | |
comment |
string | Optional comment explaining the bid |
submitted_at |
string (date-time) | |
modified_at |
string (date-time) |
Create
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
ReviewerBidRequest - API Source:
reviewer_bids_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Field | Type | Required | Description |
|---|---|---|---|
proposal |
string (uri) | ✓ | |
bid |
any | ✓ | Reviewer's preference for reviewing this proposal |
comment |
string | Optional comment explaining the bid |
201 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
call |
string (uri) | |
call_uuid |
string (uuid) | |
reviewer |
string (uri) | |
reviewer_uuid |
string (uuid) | |
reviewer_name |
string | |
proposal |
string (uri) | |
proposal_uuid |
string (uuid) | |
proposal_name |
string | |
bid |
any | Reviewer's preference for reviewing this proposal |
bid_display |
string | |
comment |
string | Optional comment explaining the bid |
submitted_at |
string (date-time) | |
modified_at |
string (date-time) |
Update
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
ReviewerBidRequest - API Source:
reviewer_bids_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
proposal |
string (uri) | ✓ | |
bid |
any | ✓ | Reviewer's preference for reviewing this proposal |
comment |
string | Optional comment explaining the bid |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
call |
string (uri) | |
call_uuid |
string (uuid) | |
reviewer |
string (uri) | |
reviewer_uuid |
string (uuid) | |
reviewer_name |
string | |
proposal |
string (uri) | |
proposal_uuid |
string (uuid) | |
proposal_name |
string | |
bid |
any | Reviewer's preference for reviewing this proposal |
bid_display |
string | |
comment |
string | Optional comment explaining the bid |
submitted_at |
string (date-time) | |
modified_at |
string (date-time) |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedReviewerBidRequest - API Source:
reviewer_bids_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
proposal |
string (uri) | ||
bid |
any | Reviewer's preference for reviewing this proposal | |
comment |
string | Optional comment explaining the bid |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
call |
string (uri) | |
call_uuid |
string (uuid) | |
reviewer |
string (uri) | |
reviewer_uuid |
string (uuid) | |
reviewer_name |
string | |
proposal |
string (uri) | |
proposal_uuid |
string (uuid) | |
proposal_name |
string | |
bid |
any | Reviewer's preference for reviewing this proposal |
bid_display |
string | |
comment |
string | Optional comment explaining the bid |
submitted_at |
string (date-time) | |
modified_at |
string (date-time) |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
reviewer_bids_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
Get my bids for a specific call
Get my bids for a specific call.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- Model Source:
BidEnum - Model Source:
ReviewerBidOEnum - API Source:
reviewer_bids_my_bids_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
bid |
array | Reviewer's preference for reviewing this proposal |
call_uuid |
string (uuid) | |
o |
array | Ordering |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
proposal_uuid |
string (uuid) | |
reviewer_uuid |
string (uuid) |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
call |
string (uri) | |
call_uuid |
string (uuid) | |
reviewer |
string (uri) | |
reviewer_uuid |
string (uuid) | |
reviewer_name |
string | |
proposal |
string (uri) | |
proposal_uuid |
string (uuid) | |
proposal_name |
string | |
bid |
any | Reviewer's preference for reviewing this proposal |
bid_display |
string | |
comment |
string | Optional comment explaining the bid |
submitted_at |
string (date-time) | |
modified_at |
string (date-time) |
Submit multiple bids at once
Submit multiple bids at once.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
- Model Source:
ReviewerBulkBidRequest - API Source:
reviewer_bids_bulk_submit
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Field | Type | Required |
|---|---|---|
bids |
array of objects | ✓ |
bids.proposal_uuid |
string (uuid) | ✓ |
bids.bid |
string | ✓ |
bids.comment |
string |
200 -
| Field | Type |
|---|---|
submitted |
integer |
Submit a bid on a proposal
Submit a bid on a proposal.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
ReviewerBidSubmitRequest - API Source:
reviewer_bids_submit
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Field | Type | Required |
|---|---|---|
proposal_uuid |
string (uuid) | ✓ |
bid |
string | ✓ |
comment |
string |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
call |
string (uri) | |
call_uuid |
string (uuid) | |
reviewer |
string (uri) | |
reviewer_uuid |
string (uuid) | |
reviewer_name |
string | |
proposal |
string (uri) | |
proposal_uuid |
string (uuid) | |
proposal_name |
string | |
bid |
any | Reviewer's preference for reviewing this proposal |
bid_display |
string | |
comment |
string | Optional comment explaining the bid |
submitted_at |
string (date-time) | |
modified_at |
string (date-time) |
Reviewer Invitations
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/reviewer-invitations/{token}/ |
Get invitation details by token |
| Other Actions | ||
| POST | /api/reviewer-invitations/{token}/accept/ |
Accept a reviewer invitation |
| POST | /api/reviewer-invitations/{token}/decline/ |
Decline a reviewer invitation |
Core CRUD
Get invitation details by token
Get invitation details by token.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
reviewer_invitations_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
token |
string | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
call_name |
string | |
call_uuid |
string (uuid) | |
invitation_status |
string | |
expires_at |
string (date-time) | |
is_expired |
boolean | |
max_assignments |
integer | |
invited_by_name |
string | Name of the person who sent the invitation |
profile_status |
string | User's profile status: 'published', 'unpublished', 'missing', or null if not authenticated |
requires_profile |
boolean | Whether the invitation requires creating a reviewer profile |
coi_configuration |
any | COI configuration for this call |
coi_types |
array of arrays | Available COI types as list of [value, label] tuples |
proposals |
array of objects | Proposals for which conflicts can be declared |
proposals.uuid |
string (uuid) | |
proposals.name |
string | |
proposals.summary |
string |
Other Actions
Accept a reviewer invitation
Accept a reviewer invitation.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
InvitationAcceptRequest - API Source:
reviewer_invitations_accept
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
token |
string | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
declared_conflicts |
array of objects | Optional list of self-declared conflicts with proposals. Each conflict creates a ConflictOfInterest record with detection_method='self_disclosed'. | |
declared_conflicts.proposal_uuid |
string (uuid) | ✓ | |
declared_conflicts.coi_type |
string | ✓ | Enum: INST_SAME, FIN_DIRECT, REL_FAMILY, ROLE_NAMED, COLLAB_ACTIVE, REL_MENTOR, REL_SUPERVISOR, COAUTH_RECENT, INST_DEPT, INST_FORMER, ROLE_CONF, COLLAB_GRANT, REL_EDITORIAL, COMPET, COAUTH_OLD, INST_CONSORT, CONF_ATTEND, SOC_MEMBER |
declared_conflicts.severity |
any | Constraints: default: apparent |
|
declared_conflicts.description |
string | Constraints: default: `` |
200 -
| Field | Type | Description |
|---|---|---|
detail |
string | |
declared_conflicts |
array of string (uuid)s | UUIDs of created conflict records |
400 -
| Field | Type |
|---|---|
error |
string |
message |
string |
profile_url |
string |
401 -
| Field | Type |
|---|---|
error |
string |
Decline a reviewer invitation
Decline a reviewer invitation.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
InvitationDeclineRequest - API Source:
reviewer_invitations_decline
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
token |
string | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
reason |
string | ✓ | Reason for declining the invitation |
200 -
| Field | Type |
|---|---|
detail |
string |
Reviewer Profiles
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/reviewer-profiles/{reviewer_profile_uuid}/affiliations/ |
Affiliations |
| GET | /api/reviewer-profiles/{reviewer_profile_uuid}/affiliations/{uuid}/ |
Retrieve |
| GET | /api/reviewer-profiles/{reviewer_profile_uuid}/expertise/ |
Expertise |
| GET | /api/reviewer-profiles/{reviewer_profile_uuid}/expertise/{uuid}/ |
Retrieve |
| GET | /api/reviewer-profiles/{reviewer_profile_uuid}/publications/ |
Publications |
| GET | /api/reviewer-profiles/{reviewer_profile_uuid}/publications/{uuid}/ |
Retrieve |
| GET | /api/reviewer-profiles/{uuid}/affiliations/ |
List affiliations for a reviewer profile |
| GET | /api/reviewer-profiles/{uuid}/connect-orcid/ |
Get ORCID OAuth authorization URL |
| GET | /api/reviewer-profiles/{uuid}/expertise/ |
List expertise keywords for a reviewer profile |
| GET | /api/reviewer-profiles/ |
List Reviewer Profiles |
| GET | /api/reviewer-profiles/me/ |
Get or create reviewer profile for the current user |
| GET | /api/reviewer-profiles/{uuid}/publications/ |
List publications for a reviewer profile |
| GET | /api/reviewer-profiles/{uuid}/ |
Retrieve |
| POST | /api/reviewer-profiles/{reviewer_profile_uuid}/affiliations/ |
Affiliations |
| POST | /api/reviewer-profiles/{reviewer_profile_uuid}/expertise/ |
Expertise |
| POST | /api/reviewer-profiles/{reviewer_profile_uuid}/publications/ |
Publications |
| POST | /api/reviewer-profiles/{uuid}/affiliations/ |
Create affiliation for a reviewer profile |
| POST | /api/reviewer-profiles/{uuid}/connect-orcid/callback/ |
Complete ORCID OAuth connection with authorization code |
| POST | /api/reviewer-profiles/ |
Create |
| POST | /api/reviewer-profiles/{uuid}/disconnect-orcid/ |
Disconnect ORCID from profile |
| POST | /api/reviewer-profiles/{uuid}/expertise/ |
Create expertise entry for a reviewer profile |
| POST | /api/reviewer-profiles/{uuid}/import-publications/ |
Import publications from ORCID or other sources |
| POST | /api/reviewer-profiles/me/ |
Get or create reviewer profile for the current user |
| POST | /api/reviewer-profiles/{uuid}/publications/ |
Create publication for a reviewer profile |
| POST | /api/reviewer-profiles/publish/ |
Publish |
| POST | /api/reviewer-profiles/{uuid}/sync-orcid/ |
Sync profile data from ORCID |
| POST | /api/reviewer-profiles/unpublish/ |
Unpublish reviewer profile to remove it from discovery |
| PUT | /api/reviewer-profiles/{reviewer_profile_uuid}/affiliations/{uuid}/ |
Update |
| PUT | /api/reviewer-profiles/{reviewer_profile_uuid}/expertise/{uuid}/ |
Update |
| PUT | /api/reviewer-profiles/{reviewer_profile_uuid}/publications/{uuid}/ |
Update |
| PUT | /api/reviewer-profiles/{uuid}/ |
Update |
| PATCH | /api/reviewer-profiles/{reviewer_profile_uuid}/affiliations/{uuid}/ |
Partial Update |
| PATCH | /api/reviewer-profiles/{reviewer_profile_uuid}/expertise/{uuid}/ |
Partial Update |
| PATCH | /api/reviewer-profiles/{reviewer_profile_uuid}/publications/{uuid}/ |
Partial Update |
| PATCH | /api/reviewer-profiles/me/ |
Get or create reviewer profile for the current user |
| PATCH | /api/reviewer-profiles/{uuid}/ |
Partial Update |
| DELETE | /api/reviewer-profiles/{reviewer_profile_uuid}/affiliations/{uuid}/ |
Delete |
| DELETE | /api/reviewer-profiles/{reviewer_profile_uuid}/expertise/{uuid}/ |
Delete |
| DELETE | /api/reviewer-profiles/{reviewer_profile_uuid}/publications/{uuid}/ |
Delete |
| DELETE | /api/reviewer-profiles/{uuid}/ |
Delete |
Affiliations
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- API Source:
nested_reviewer_profile_affiliations_list
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required | Description |
|---|---|---|---|
reviewer_profile_uuid |
string | ✓ | UUID of the parent reviewer profile |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
organization |
string (uuid) | |
organization_name |
string | Organization name (used when not linked to Waldur org) |
organization_name_display |
string | Return organization name from linked Customer or from the text field. |
organization_identifier |
string | ROR, GRID, or other external identifier |
department |
string | |
position_title |
string | |
start_date |
string (date) | |
end_date |
string (date) | Leave empty for current affiliation |
is_primary |
boolean | |
affiliation_type |
string | Enum: employment, education, visiting, honorary, consulting |
created |
string (date-time) |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- API Source:
nested_reviewer_profile_affiliations_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Name | Type | Required | Description |
|---|---|---|---|
reviewer_profile_uuid |
string | ✓ | UUID of the parent reviewer profile |
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
organization |
string (uuid) | |
organization_name |
string | Organization name (used when not linked to Waldur org) |
organization_name_display |
string | Return organization name from linked Customer or from the text field. |
organization_identifier |
string | ROR, GRID, or other external identifier |
department |
string | |
position_title |
string | |
start_date |
string (date) | |
end_date |
string (date) | Leave empty for current affiliation |
is_primary |
boolean | |
affiliation_type |
string | Enum: employment, education, visiting, honorary, consulting |
created |
string (date-time) |
Expertise
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- API Source:
nested_reviewer_profile_expertise_list
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required | Description |
|---|---|---|---|
reviewer_profile_uuid |
string | ✓ | UUID of the parent reviewer profile |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
expertise_keyword |
string | Free-text keyword |
expertise_category |
string (uuid) | |
expertise_category_name |
string | |
proficiency_level |
string | Enum: expert, familiar, basic |
years_experience |
integer | |
last_active_date |
string (date) | When last worked in this area |
created |
string (date-time) |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- API Source:
nested_reviewer_profile_expertise_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Name | Type | Required | Description |
|---|---|---|---|
reviewer_profile_uuid |
string | ✓ | UUID of the parent reviewer profile |
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
expertise_keyword |
string | Free-text keyword |
expertise_category |
string (uuid) | |
expertise_category_name |
string | |
proficiency_level |
string | Enum: expert, familiar, basic |
years_experience |
integer | |
last_active_date |
string (date) | When last worked in this area |
created |
string (date-time) |
Publications
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- API Source:
nested_reviewer_profile_publications_list
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required | Description |
|---|---|---|---|
reviewer_profile_uuid |
string | ✓ | UUID of the parent reviewer profile |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
title |
string | |
doi |
string | Digital Object Identifier |
publication_year |
integer | |
venue |
string | Journal or conference name |
venue_type |
string | Enum: journal, conference, preprint, book, thesis, report, other |
abstract |
string | |
coauthors |
any | List of co-author names and identifiers |
external_ids |
any | External identifiers: |
is_excluded_from_matching |
boolean | User can exclude old papers from expertise matching |
created |
string (date-time) |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- API Source:
nested_reviewer_profile_publications_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Name | Type | Required | Description |
|---|---|---|---|
reviewer_profile_uuid |
string | ✓ | UUID of the parent reviewer profile |
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
title |
string | |
doi |
string | Digital Object Identifier |
publication_year |
integer | |
venue |
string | Journal or conference name |
venue_type |
string | Enum: journal, conference, preprint, book, thesis, report, other |
abstract |
string | |
coauthors |
any | List of co-author names and identifiers |
external_ids |
any | External identifiers: |
is_excluded_from_matching |
boolean | User can exclude old papers from expertise matching |
created |
string (date-time) |
List affiliations for a reviewer profile
List affiliations for a reviewer profile.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- API Source:
reviewer_profiles_affiliations_list
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
organization |
string (uuid) | |
organization_name |
string | Organization name (used when not linked to Waldur org) |
organization_name_display |
string | Return organization name from linked Customer or from the text field. |
organization_identifier |
string | ROR, GRID, or other external identifier |
department |
string | |
position_title |
string | |
start_date |
string (date) | |
end_date |
string (date) | Leave empty for current affiliation |
is_primary |
boolean | |
affiliation_type |
string | Enum: employment, education, visiting, honorary, consulting |
created |
string (date-time) |
Get ORCID OAuth authorization URL
Get ORCID OAuth authorization URL.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
reviewer_profiles_connect_orcid_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
authorization_url |
string |
List expertise keywords for a reviewer profile
List expertise keywords for a reviewer profile.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- API Source:
reviewer_profiles_expertise_list
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
expertise_keyword |
string | Free-text keyword |
expertise_category |
string (uuid) | |
expertise_category_name |
string | |
proficiency_level |
string | Enum: expert, familiar, basic |
years_experience |
integer | |
last_active_date |
string (date) | When last worked in this area |
created |
string (date-time) |
List Reviewer Profiles
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 | |
- Model Source:
ReviewerProfileOEnum - API Source:
reviewer_profiles_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
expertise_category_uuid |
string (uuid) | |
expertise_keyword |
string | |
has_orcid |
boolean | |
o |
array | Ordering |
orcid_id |
string | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
user_email |
string | |
user_name |
string | |
user_uuid |
string (uuid) |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
user |
string (uri) | |
user_uuid |
string (uuid) | |
user_full_name |
string | |
user_email |
string (email) | |
orcid_id |
string | ORCID identifier (format: 0000-0000-0000-0000) |
orcid_connected |
boolean | Check if ORCID is connected (has access token). |
orcid_last_sync |
string (date-time) | |
biography |
string | Professional biography / summary |
alternative_names |
any | List of name variants used in publications |
affiliations |
array of objects | |
affiliations.uuid |
string (uuid) | |
affiliations.organization |
string (uuid) | |
affiliations.organization_name |
string | Organization name (used when not linked to Waldur org) |
affiliations.organization_name_display |
string | Return organization name from linked Customer or from the text field. |
affiliations.organization_identifier |
string | ROR, GRID, or other external identifier |
affiliations.department |
string | |
affiliations.position_title |
string | |
affiliations.start_date |
string (date) | |
affiliations.end_date |
string (date) | Leave empty for current affiliation |
affiliations.is_primary |
boolean | |
affiliations.affiliation_type |
string | Enum: employment, education, visiting, honorary, consulting |
affiliations.created |
string (date-time) | |
expertise_set |
array of objects | |
expertise_set.uuid |
string (uuid) | |
expertise_set.expertise_keyword |
string | Free-text keyword |
expertise_set.expertise_category |
string (uuid) | |
expertise_set.expertise_category_name |
string | |
expertise_set.proficiency_level |
string | Enum: expert, familiar, basic |
expertise_set.years_experience |
integer | |
expertise_set.last_active_date |
string (date) | When last worked in this area |
expertise_set.created |
string (date-time) | |
publications |
array of objects | |
publications.uuid |
string (uuid) | |
publications.title |
string | |
publications.doi |
string | Digital Object Identifier |
publications.publication_year |
integer | |
publications.venue |
string | Journal or conference name |
publications.venue_type |
string | Enum: journal, conference, preprint, book, thesis, report, other |
publications.abstract |
string | |
publications.coauthors |
any | List of co-author names and identifiers |
publications.external_ids |
any | External identifiers: |
publications.is_excluded_from_matching |
boolean | User can exclude old papers from expertise matching |
publications.created |
string (date-time) | |
stats |
any | |
profile_completeness |
object (free-form) | Calculate profile completeness percentage and missing fields. |
is_published |
boolean | Whether profile is discoverable by call managers |
published_at |
string (date-time) | When the profile was published |
available_for_reviews |
boolean | Whether reviewer is currently accepting review requests |
created |
string (date-time) | |
modified |
string (date-time) |
Get or create reviewer profile for the current user
Get or create reviewer profile for the current user.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
- API Source:
reviewer_profiles_me_retrieve
1 2 3 4 5 6 7 8 9 10 | |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
user |
string (uri) | |
user_uuid |
string (uuid) | |
user_full_name |
string | |
user_email |
string (email) | |
orcid_id |
string | ORCID identifier (format: 0000-0000-0000-0000) |
orcid_connected |
boolean | Check if ORCID is connected (has access token). |
orcid_last_sync |
string (date-time) | |
biography |
string | Professional biography / summary |
alternative_names |
any | List of name variants used in publications |
affiliations |
array of objects | |
affiliations.uuid |
string (uuid) | |
affiliations.organization |
string (uuid) | |
affiliations.organization_name |
string | Organization name (used when not linked to Waldur org) |
affiliations.organization_name_display |
string | Return organization name from linked Customer or from the text field. |
affiliations.organization_identifier |
string | ROR, GRID, or other external identifier |
affiliations.department |
string | |
affiliations.position_title |
string | |
affiliations.start_date |
string (date) | |
affiliations.end_date |
string (date) | Leave empty for current affiliation |
affiliations.is_primary |
boolean | |
affiliations.affiliation_type |
string | Enum: employment, education, visiting, honorary, consulting |
affiliations.created |
string (date-time) | |
expertise_set |
array of objects | |
expertise_set.uuid |
string (uuid) | |
expertise_set.expertise_keyword |
string | Free-text keyword |
expertise_set.expertise_category |
string (uuid) | |
expertise_set.expertise_category_name |
string | |
expertise_set.proficiency_level |
string | Enum: expert, familiar, basic |
expertise_set.years_experience |
integer | |
expertise_set.last_active_date |
string (date) | When last worked in this area |
expertise_set.created |
string (date-time) | |
publications |
array of objects | |
publications.uuid |
string (uuid) | |
publications.title |
string | |
publications.doi |
string | Digital Object Identifier |
publications.publication_year |
integer | |
publications.venue |
string | Journal or conference name |
publications.venue_type |
string | Enum: journal, conference, preprint, book, thesis, report, other |
publications.abstract |
string | |
publications.coauthors |
any | List of co-author names and identifiers |
publications.external_ids |
any | External identifiers: |
publications.is_excluded_from_matching |
boolean | User can exclude old papers from expertise matching |
publications.created |
string (date-time) | |
stats |
any | |
profile_completeness |
object (free-form) | Calculate profile completeness percentage and missing fields. |
is_published |
boolean | Whether profile is discoverable by call managers |
published_at |
string (date-time) | When the profile was published |
available_for_reviews |
boolean | Whether reviewer is currently accepting review requests |
created |
string (date-time) | |
modified |
string (date-time) |
List publications for a reviewer profile
List publications for a reviewer profile.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- API Source:
reviewer_profiles_publications_list
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
title |
string | |
doi |
string | Digital Object Identifier |
publication_year |
integer | |
venue |
string | Journal or conference name |
venue_type |
string | Enum: journal, conference, preprint, book, thesis, report, other |
abstract |
string | |
coauthors |
any | List of co-author names and identifiers |
external_ids |
any | External identifiers: |
is_excluded_from_matching |
boolean | User can exclude old papers from expertise matching |
created |
string (date-time) |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
reviewer_profiles_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
user |
string (uri) | |
user_uuid |
string (uuid) | |
user_full_name |
string | |
user_email |
string (email) | |
orcid_id |
string | ORCID identifier (format: 0000-0000-0000-0000) |
orcid_connected |
boolean | Check if ORCID is connected (has access token). |
orcid_last_sync |
string (date-time) | |
biography |
string | Professional biography / summary |
alternative_names |
any | List of name variants used in publications |
affiliations |
array of objects | |
affiliations.uuid |
string (uuid) | |
affiliations.organization |
string (uuid) | |
affiliations.organization_name |
string | Organization name (used when not linked to Waldur org) |
affiliations.organization_name_display |
string | Return organization name from linked Customer or from the text field. |
affiliations.organization_identifier |
string | ROR, GRID, or other external identifier |
affiliations.department |
string | |
affiliations.position_title |
string | |
affiliations.start_date |
string (date) | |
affiliations.end_date |
string (date) | Leave empty for current affiliation |
affiliations.is_primary |
boolean | |
affiliations.affiliation_type |
string | Enum: employment, education, visiting, honorary, consulting |
affiliations.created |
string (date-time) | |
expertise_set |
array of objects | |
expertise_set.uuid |
string (uuid) | |
expertise_set.expertise_keyword |
string | Free-text keyword |
expertise_set.expertise_category |
string (uuid) | |
expertise_set.expertise_category_name |
string | |
expertise_set.proficiency_level |
string | Enum: expert, familiar, basic |
expertise_set.years_experience |
integer | |
expertise_set.last_active_date |
string (date) | When last worked in this area |
expertise_set.created |
string (date-time) | |
publications |
array of objects | |
publications.uuid |
string (uuid) | |
publications.title |
string | |
publications.doi |
string | Digital Object Identifier |
publications.publication_year |
integer | |
publications.venue |
string | Journal or conference name |
publications.venue_type |
string | Enum: journal, conference, preprint, book, thesis, report, other |
publications.abstract |
string | |
publications.coauthors |
any | List of co-author names and identifiers |
publications.external_ids |
any | External identifiers: |
publications.is_excluded_from_matching |
boolean | User can exclude old papers from expertise matching |
publications.created |
string (date-time) | |
stats |
any | |
profile_completeness |
object (free-form) | Calculate profile completeness percentage and missing fields. |
is_published |
boolean | Whether profile is discoverable by call managers |
published_at |
string (date-time) | When the profile was published |
available_for_reviews |
boolean | Whether reviewer is currently accepting review requests |
created |
string (date-time) | |
modified |
string (date-time) |
Affiliations
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
ReviewerAffiliationRequest - API Source:
nested_reviewer_profile_affiliations_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required | Description |
|---|---|---|---|
reviewer_profile_uuid |
string | ✓ | UUID of the parent reviewer profile |
| Field | Type | Required | Description |
|---|---|---|---|
organization |
string (uuid) | ||
organization_name |
string | ✓ | Organization name (used when not linked to Waldur org) |
organization_identifier |
string | ROR, GRID, or other external identifier | |
department |
string | ||
position_title |
string | ||
start_date |
string (date) | ||
end_date |
string (date) | Leave empty for current affiliation | |
is_primary |
boolean | ||
affiliation_type |
string | Enum: employment, education, visiting, honorary, consulting |
201 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
organization |
string (uuid) | |
organization_name |
string | Organization name (used when not linked to Waldur org) |
organization_name_display |
string | Return organization name from linked Customer or from the text field. |
organization_identifier |
string | ROR, GRID, or other external identifier |
department |
string | |
position_title |
string | |
start_date |
string (date) | |
end_date |
string (date) | Leave empty for current affiliation |
is_primary |
boolean | |
affiliation_type |
string | Enum: employment, education, visiting, honorary, consulting |
created |
string (date-time) |
Expertise
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
ReviewerExpertiseRequest - API Source:
nested_reviewer_profile_expertise_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required | Description |
|---|---|---|---|
reviewer_profile_uuid |
string | ✓ | UUID of the parent reviewer profile |
| Field | Type | Required | Description |
|---|---|---|---|
expertise_keyword |
string | ✓ | Free-text keyword |
expertise_category |
string (uuid) | ||
proficiency_level |
string | Enum: expert, familiar, basic |
|
years_experience |
integer | ||
last_active_date |
string (date) | When last worked in this area |
201 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
expertise_keyword |
string | Free-text keyword |
expertise_category |
string (uuid) | |
expertise_category_name |
string | |
proficiency_level |
string | Enum: expert, familiar, basic |
years_experience |
integer | |
last_active_date |
string (date) | When last worked in this area |
created |
string (date-time) |
Publications
1 2 3 4 5 6 7 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | |
- Model Source:
ReviewerPublicationRequest - API Source:
nested_reviewer_profile_publications_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
| Name | Type | Required | Description |
|---|---|---|---|
reviewer_profile_uuid |
string | ✓ | UUID of the parent reviewer profile |
| Field | Type | Required | Description |
|---|---|---|---|
title |
string | ✓ | |
doi |
string | Digital Object Identifier | |
publication_year |
integer | ✓ | |
venue |
string | ✓ | Journal or conference name |
venue_type |
string | Enum: journal, conference, preprint, book, thesis, report, other |
|
abstract |
string | ||
coauthors |
any | List of co-author names and identifiers | |
external_ids |
any | External identifiers: | |
is_excluded_from_matching |
boolean | User can exclude old papers from expertise matching |
201 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
title |
string | |
doi |
string | Digital Object Identifier |
publication_year |
integer | |
venue |
string | Journal or conference name |
venue_type |
string | Enum: journal, conference, preprint, book, thesis, report, other |
abstract |
string | |
coauthors |
any | List of co-author names and identifiers |
external_ids |
any | External identifiers: |
is_excluded_from_matching |
boolean | User can exclude old papers from expertise matching |
created |
string (date-time) |
Create affiliation for a reviewer profile
Create affiliation for a reviewer profile.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
ReviewerAffiliationRequest - API Source:
reviewer_profiles_affiliations_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
organization |
string (uuid) | ||
organization_name |
string | ✓ | Organization name (used when not linked to Waldur org) |
organization_identifier |
string | ROR, GRID, or other external identifier | |
department |
string | ||
position_title |
string | ||
start_date |
string (date) | ||
end_date |
string (date) | Leave empty for current affiliation | |
is_primary |
boolean | ||
affiliation_type |
string | Enum: employment, education, visiting, honorary, consulting |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
organization |
string (uuid) | |
organization_name |
string | Organization name (used when not linked to Waldur org) |
organization_name_display |
string | Return organization name from linked Customer or from the text field. |
organization_identifier |
string | ROR, GRID, or other external identifier |
department |
string | |
position_title |
string | |
start_date |
string (date) | |
end_date |
string (date) | Leave empty for current affiliation |
is_primary |
boolean | |
affiliation_type |
string | Enum: employment, education, visiting, honorary, consulting |
created |
string (date-time) |
Complete ORCID OAuth connection with authorization code
Complete ORCID OAuth connection with authorization code.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
OrcidCallbackRequest - API Source:
reviewer_profiles_connect_orcid_callback
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
code |
string | ✓ | Authorization code from ORCID OAuth callback |
state |
string | State token for CSRF protection |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
user |
string (uri) | |
user_uuid |
string (uuid) | |
user_full_name |
string | |
user_email |
string (email) | |
orcid_id |
string | ORCID identifier (format: 0000-0000-0000-0000) |
orcid_connected |
boolean | Check if ORCID is connected (has access token). |
orcid_last_sync |
string (date-time) | |
biography |
string | Professional biography / summary |
alternative_names |
any | List of name variants used in publications |
affiliations |
array of objects | |
affiliations.uuid |
string (uuid) | |
affiliations.organization |
string (uuid) | |
affiliations.organization_name |
string | Organization name (used when not linked to Waldur org) |
affiliations.organization_name_display |
string | Return organization name from linked Customer or from the text field. |
affiliations.organization_identifier |
string | ROR, GRID, or other external identifier |
affiliations.department |
string | |
affiliations.position_title |
string | |
affiliations.start_date |
string (date) | |
affiliations.end_date |
string (date) | Leave empty for current affiliation |
affiliations.is_primary |
boolean | |
affiliations.affiliation_type |
string | Enum: employment, education, visiting, honorary, consulting |
affiliations.created |
string (date-time) | |
expertise_set |
array of objects | |
expertise_set.uuid |
string (uuid) | |
expertise_set.expertise_keyword |
string | Free-text keyword |
expertise_set.expertise_category |
string (uuid) | |
expertise_set.expertise_category_name |
string | |
expertise_set.proficiency_level |
string | Enum: expert, familiar, basic |
expertise_set.years_experience |
integer | |
expertise_set.last_active_date |
string (date) | When last worked in this area |
expertise_set.created |
string (date-time) | |
publications |
array of objects | |
publications.uuid |
string (uuid) | |
publications.title |
string | |
publications.doi |
string | Digital Object Identifier |
publications.publication_year |
integer | |
publications.venue |
string | Journal or conference name |
publications.venue_type |
string | Enum: journal, conference, preprint, book, thesis, report, other |
publications.abstract |
string | |
publications.coauthors |
any | List of co-author names and identifiers |
publications.external_ids |
any | External identifiers: |
publications.is_excluded_from_matching |
boolean | User can exclude old papers from expertise matching |
publications.created |
string (date-time) | |
stats |
any | |
profile_completeness |
object (free-form) | Calculate profile completeness percentage and missing fields. |
is_published |
boolean | Whether profile is discoverable by call managers |
published_at |
string (date-time) | When the profile was published |
available_for_reviews |
boolean | Whether reviewer is currently accepting review requests |
created |
string (date-time) | |
modified |
string (date-time) |
Create
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
- Model Source:
ReviewerProfileRequest - API Source:
reviewer_profiles_create
1 2 3 4 5 6 7 8 9 10 | |
| Field | Type | Required | Description |
|---|---|---|---|
orcid_id |
string | ORCID identifier (format: 0000-0000-0000-0000) | |
biography |
string | Professional biography / summary | |
alternative_names |
any | List of name variants used in publications | |
available_for_reviews |
boolean | Whether reviewer is currently accepting review requests |
201 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
user |
string (uri) | |
user_uuid |
string (uuid) | |
user_full_name |
string | |
user_email |
string (email) | |
orcid_id |
string | ORCID identifier (format: 0000-0000-0000-0000) |
orcid_connected |
boolean | Check if ORCID is connected (has access token). |
orcid_last_sync |
string (date-time) | |
biography |
string | Professional biography / summary |
alternative_names |
any | List of name variants used in publications |
affiliations |
array of objects | |
affiliations.uuid |
string (uuid) | |
affiliations.organization |
string (uuid) | |
affiliations.organization_name |
string | Organization name (used when not linked to Waldur org) |
affiliations.organization_name_display |
string | Return organization name from linked Customer or from the text field. |
affiliations.organization_identifier |
string | ROR, GRID, or other external identifier |
affiliations.department |
string | |
affiliations.position_title |
string | |
affiliations.start_date |
string (date) | |
affiliations.end_date |
string (date) | Leave empty for current affiliation |
affiliations.is_primary |
boolean | |
affiliations.affiliation_type |
string | Enum: employment, education, visiting, honorary, consulting |
affiliations.created |
string (date-time) | |
expertise_set |
array of objects | |
expertise_set.uuid |
string (uuid) | |
expertise_set.expertise_keyword |
string | Free-text keyword |
expertise_set.expertise_category |
string (uuid) | |
expertise_set.expertise_category_name |
string | |
expertise_set.proficiency_level |
string | Enum: expert, familiar, basic |
expertise_set.years_experience |
integer | |
expertise_set.last_active_date |
string (date) | When last worked in this area |
expertise_set.created |
string (date-time) | |
publications |
array of objects | |
publications.uuid |
string (uuid) | |
publications.title |
string | |
publications.doi |
string | Digital Object Identifier |
publications.publication_year |
integer | |
publications.venue |
string | Journal or conference name |
publications.venue_type |
string | Enum: journal, conference, preprint, book, thesis, report, other |
publications.abstract |
string | |
publications.coauthors |
any | List of co-author names and identifiers |
publications.external_ids |
any | External identifiers: |
publications.is_excluded_from_matching |
boolean | User can exclude old papers from expertise matching |
publications.created |
string (date-time) | |
stats |
any | |
profile_completeness |
object (free-form) | Calculate profile completeness percentage and missing fields. |
is_published |
boolean | Whether profile is discoverable by call managers |
published_at |
string (date-time) | When the profile was published |
available_for_reviews |
boolean | Whether reviewer is currently accepting review requests |
created |
string (date-time) | |
modified |
string (date-time) |
Disconnect ORCID from profile
Disconnect ORCID from profile.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
ReviewerProfileRequest - API Source:
reviewer_profiles_disconnect_orcid
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
orcid_id |
string | ORCID identifier (format: 0000-0000-0000-0000) | |
biography |
string | Professional biography / summary | |
alternative_names |
any | List of name variants used in publications | |
available_for_reviews |
boolean | Whether reviewer is currently accepting review requests |
200 -
| Field | Type |
|---|---|
detail |
string |
Create expertise entry for a reviewer profile
Create expertise entry for a reviewer profile.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
ReviewerExpertiseRequest - API Source:
reviewer_profiles_expertise_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
expertise_keyword |
string | ✓ | Free-text keyword |
expertise_category |
string (uuid) | ||
proficiency_level |
string | Enum: expert, familiar, basic |
|
years_experience |
integer | ||
last_active_date |
string (date) | When last worked in this area |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
expertise_keyword |
string | Free-text keyword |
expertise_category |
string (uuid) | |
expertise_category_name |
string | |
proficiency_level |
string | Enum: expert, familiar, basic |
years_experience |
integer | |
last_active_date |
string (date) | When last worked in this area |
created |
string (date-time) |
Import publications from ORCID or other sources
Import publications from ORCID or other sources.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
ImportPublicationsRequest - API Source:
reviewer_profiles_import_publications
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
source |
any | Source to import publications from Constraints: default: orcid |
|
doi |
string | DOI of publication to import (required if source is 'doi') |
200 -
| Field | Type |
|---|---|
imported_count |
integer |
Get or create reviewer profile for the current user
Get or create reviewer profile for the current user.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
- Model Source:
ReviewerProfileCreateRequest - API Source:
reviewer_profiles_me
1 2 3 4 5 6 7 8 9 10 | |
| Field | Type | Required | Description |
|---|---|---|---|
orcid_id |
string | ORCID identifier (format: 0000-0000-0000-0000) | |
biography |
string | Professional biography / summary | |
alternative_names |
any | List of name variants used in publications | |
available_for_reviews |
boolean | Whether reviewer is currently accepting review requests |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
user |
string (uri) | |
user_uuid |
string (uuid) | |
user_full_name |
string | |
user_email |
string (email) | |
orcid_id |
string | ORCID identifier (format: 0000-0000-0000-0000) |
orcid_connected |
boolean | Check if ORCID is connected (has access token). |
orcid_last_sync |
string (date-time) | |
biography |
string | Professional biography / summary |
alternative_names |
any | List of name variants used in publications |
affiliations |
array of objects | |
affiliations.uuid |
string (uuid) | |
affiliations.organization |
string (uuid) | |
affiliations.organization_name |
string | Organization name (used when not linked to Waldur org) |
affiliations.organization_name_display |
string | Return organization name from linked Customer or from the text field. |
affiliations.organization_identifier |
string | ROR, GRID, or other external identifier |
affiliations.department |
string | |
affiliations.position_title |
string | |
affiliations.start_date |
string (date) | |
affiliations.end_date |
string (date) | Leave empty for current affiliation |
affiliations.is_primary |
boolean | |
affiliations.affiliation_type |
string | Enum: employment, education, visiting, honorary, consulting |
affiliations.created |
string (date-time) | |
expertise_set |
array of objects | |
expertise_set.uuid |
string (uuid) | |
expertise_set.expertise_keyword |
string | Free-text keyword |
expertise_set.expertise_category |
string (uuid) | |
expertise_set.expertise_category_name |
string | |
expertise_set.proficiency_level |
string | Enum: expert, familiar, basic |
expertise_set.years_experience |
integer | |
expertise_set.last_active_date |
string (date) | When last worked in this area |
expertise_set.created |
string (date-time) | |
publications |
array of objects | |
publications.uuid |
string (uuid) | |
publications.title |
string | |
publications.doi |
string | Digital Object Identifier |
publications.publication_year |
integer | |
publications.venue |
string | Journal or conference name |
publications.venue_type |
string | Enum: journal, conference, preprint, book, thesis, report, other |
publications.abstract |
string | |
publications.coauthors |
any | List of co-author names and identifiers |
publications.external_ids |
any | External identifiers: |
publications.is_excluded_from_matching |
boolean | User can exclude old papers from expertise matching |
publications.created |
string (date-time) | |
stats |
any | |
profile_completeness |
object (free-form) | Calculate profile completeness percentage and missing fields. |
is_published |
boolean | Whether profile is discoverable by call managers |
published_at |
string (date-time) | When the profile was published |
available_for_reviews |
boolean | Whether reviewer is currently accepting review requests |
created |
string (date-time) | |
modified |
string (date-time) |
Create publication for a reviewer profile
Create publication for a reviewer profile.
1 2 3 4 5 6 7 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | |
- Model Source:
ReviewerPublicationRequest - API Source:
reviewer_profiles_publications_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
title |
string | ✓ | |
doi |
string | Digital Object Identifier | |
publication_year |
integer | ✓ | |
venue |
string | ✓ | Journal or conference name |
venue_type |
string | Enum: journal, conference, preprint, book, thesis, report, other |
|
abstract |
string | ||
coauthors |
any | List of co-author names and identifiers | |
external_ids |
any | External identifiers: | |
is_excluded_from_matching |
boolean | User can exclude old papers from expertise matching |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
title |
string | |
doi |
string | Digital Object Identifier |
publication_year |
integer | |
venue |
string | Journal or conference name |
venue_type |
string | Enum: journal, conference, preprint, book, thesis, report, other |
abstract |
string | |
coauthors |
any | List of co-author names and identifiers |
external_ids |
any | External identifiers: |
is_excluded_from_matching |
boolean | User can exclude old papers from expertise matching |
created |
string (date-time) |
Publish
Publish reviewer profile for discovery by call managers. Warning: Publishing makes your full profile visible to call managers globally.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
- Model Source:
ReviewerProfileRequest - API Source:
reviewer_profiles_publish
1 2 3 4 5 6 7 8 9 10 | |
| Field | Type | Required | Description |
|---|---|---|---|
orcid_id |
string | ORCID identifier (format: 0000-0000-0000-0000) | |
biography |
string | Professional biography / summary | |
alternative_names |
any | List of name variants used in publications | |
available_for_reviews |
boolean | Whether reviewer is currently accepting review requests |
200 -
| Field | Type |
|---|---|
is_published |
boolean |
published_at |
string (date-time) |
warning |
string |
Sync profile data from ORCID
Sync profile data from ORCID.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
ReviewerProfileRequest - API Source:
reviewer_profiles_sync_orcid
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
orcid_id |
string | ORCID identifier (format: 0000-0000-0000-0000) | |
biography |
string | Professional biography / summary | |
alternative_names |
any | List of name variants used in publications | |
available_for_reviews |
boolean | Whether reviewer is currently accepting review requests |
200 -
| Field | Type |
|---|---|
imported |
object (free-form) |
last_sync |
string (date-time) |
Unpublish reviewer profile to remove it from discovery
Unpublish reviewer profile to remove it from discovery.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
- Model Source:
ReviewerProfileRequest - API Source:
reviewer_profiles_unpublish
1 2 3 4 5 6 7 8 9 10 | |
| Field | Type | Required | Description |
|---|---|---|---|
orcid_id |
string | ORCID identifier (format: 0000-0000-0000-0000) | |
biography |
string | Professional biography / summary | |
alternative_names |
any | List of name variants used in publications | |
available_for_reviews |
boolean | Whether reviewer is currently accepting review requests |
200 -
| Field | Type |
|---|---|
is_published |
boolean |
detail |
string |
Update
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
ReviewerAffiliationRequest - API Source:
nested_reviewer_profile_affiliations_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required | Description |
|---|---|---|---|
reviewer_profile_uuid |
string | ✓ | UUID of the parent reviewer profile |
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
organization |
string (uuid) | ||
organization_name |
string | ✓ | Organization name (used when not linked to Waldur org) |
organization_identifier |
string | ROR, GRID, or other external identifier | |
department |
string | ||
position_title |
string | ||
start_date |
string (date) | ||
end_date |
string (date) | Leave empty for current affiliation | |
is_primary |
boolean | ||
affiliation_type |
string | Enum: employment, education, visiting, honorary, consulting |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
organization |
string (uuid) | |
organization_name |
string | Organization name (used when not linked to Waldur org) |
organization_name_display |
string | Return organization name from linked Customer or from the text field. |
organization_identifier |
string | ROR, GRID, or other external identifier |
department |
string | |
position_title |
string | |
start_date |
string (date) | |
end_date |
string (date) | Leave empty for current affiliation |
is_primary |
boolean | |
affiliation_type |
string | Enum: employment, education, visiting, honorary, consulting |
created |
string (date-time) |
Update
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
ReviewerExpertiseRequest - API Source:
nested_reviewer_profile_expertise_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required | Description |
|---|---|---|---|
reviewer_profile_uuid |
string | ✓ | UUID of the parent reviewer profile |
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
expertise_keyword |
string | ✓ | Free-text keyword |
expertise_category |
string (uuid) | ||
proficiency_level |
string | Enum: expert, familiar, basic |
|
years_experience |
integer | ||
last_active_date |
string (date) | When last worked in this area |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
expertise_keyword |
string | Free-text keyword |
expertise_category |
string (uuid) | |
expertise_category_name |
string | |
proficiency_level |
string | Enum: expert, familiar, basic |
years_experience |
integer | |
last_active_date |
string (date) | When last worked in this area |
created |
string (date-time) |
Update
1 2 3 4 5 6 7 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 | |
- Model Source:
ReviewerPublicationRequest - API Source:
nested_reviewer_profile_publications_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
| Name | Type | Required | Description |
|---|---|---|---|
reviewer_profile_uuid |
string | ✓ | UUID of the parent reviewer profile |
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
title |
string | ✓ | |
doi |
string | Digital Object Identifier | |
publication_year |
integer | ✓ | |
venue |
string | ✓ | Journal or conference name |
venue_type |
string | Enum: journal, conference, preprint, book, thesis, report, other |
|
abstract |
string | ||
coauthors |
any | List of co-author names and identifiers | |
external_ids |
any | External identifiers: | |
is_excluded_from_matching |
boolean | User can exclude old papers from expertise matching |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
title |
string | |
doi |
string | Digital Object Identifier |
publication_year |
integer | |
venue |
string | Journal or conference name |
venue_type |
string | Enum: journal, conference, preprint, book, thesis, report, other |
abstract |
string | |
coauthors |
any | List of co-author names and identifiers |
external_ids |
any | External identifiers: |
is_excluded_from_matching |
boolean | User can exclude old papers from expertise matching |
created |
string (date-time) |
Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
ReviewerProfileRequest - API Source:
reviewer_profiles_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
orcid_id |
string | ORCID identifier (format: 0000-0000-0000-0000) | |
biography |
string | Professional biography / summary | |
alternative_names |
any | List of name variants used in publications | |
available_for_reviews |
boolean | Whether reviewer is currently accepting review requests |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
user |
string (uri) | |
user_uuid |
string (uuid) | |
user_full_name |
string | |
user_email |
string (email) | |
orcid_id |
string | ORCID identifier (format: 0000-0000-0000-0000) |
orcid_connected |
boolean | Check if ORCID is connected (has access token). |
orcid_last_sync |
string (date-time) | |
biography |
string | Professional biography / summary |
alternative_names |
any | List of name variants used in publications |
affiliations |
array of objects | |
affiliations.uuid |
string (uuid) | |
affiliations.organization |
string (uuid) | |
affiliations.organization_name |
string | Organization name (used when not linked to Waldur org) |
affiliations.organization_name_display |
string | Return organization name from linked Customer or from the text field. |
affiliations.organization_identifier |
string | ROR, GRID, or other external identifier |
affiliations.department |
string | |
affiliations.position_title |
string | |
affiliations.start_date |
string (date) | |
affiliations.end_date |
string (date) | Leave empty for current affiliation |
affiliations.is_primary |
boolean | |
affiliations.affiliation_type |
string | Enum: employment, education, visiting, honorary, consulting |
affiliations.created |
string (date-time) | |
expertise_set |
array of objects | |
expertise_set.uuid |
string (uuid) | |
expertise_set.expertise_keyword |
string | Free-text keyword |
expertise_set.expertise_category |
string (uuid) | |
expertise_set.expertise_category_name |
string | |
expertise_set.proficiency_level |
string | Enum: expert, familiar, basic |
expertise_set.years_experience |
integer | |
expertise_set.last_active_date |
string (date) | When last worked in this area |
expertise_set.created |
string (date-time) | |
publications |
array of objects | |
publications.uuid |
string (uuid) | |
publications.title |
string | |
publications.doi |
string | Digital Object Identifier |
publications.publication_year |
integer | |
publications.venue |
string | Journal or conference name |
publications.venue_type |
string | Enum: journal, conference, preprint, book, thesis, report, other |
publications.abstract |
string | |
publications.coauthors |
any | List of co-author names and identifiers |
publications.external_ids |
any | External identifiers: |
publications.is_excluded_from_matching |
boolean | User can exclude old papers from expertise matching |
publications.created |
string (date-time) | |
stats |
any | |
profile_completeness |
object (free-form) | Calculate profile completeness percentage and missing fields. |
is_published |
boolean | Whether profile is discoverable by call managers |
published_at |
string (date-time) | When the profile was published |
available_for_reviews |
boolean | Whether reviewer is currently accepting review requests |
created |
string (date-time) | |
modified |
string (date-time) |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
- Model Source:
PatchedReviewerAffiliationRequest - API Source:
nested_reviewer_profile_affiliations_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Name | Type | Required | Description |
|---|---|---|---|
reviewer_profile_uuid |
string | ✓ | UUID of the parent reviewer profile |
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
organization |
string (uuid) | ||
organization_name |
string | Organization name (used when not linked to Waldur org) | |
organization_identifier |
string | ROR, GRID, or other external identifier | |
department |
string | ||
position_title |
string | ||
start_date |
string (date) | ||
end_date |
string (date) | Leave empty for current affiliation | |
is_primary |
boolean | ||
affiliation_type |
string | Enum: employment, education, visiting, honorary, consulting |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
organization |
string (uuid) | |
organization_name |
string | Organization name (used when not linked to Waldur org) |
organization_name_display |
string | Return organization name from linked Customer or from the text field. |
organization_identifier |
string | ROR, GRID, or other external identifier |
department |
string | |
position_title |
string | |
start_date |
string (date) | |
end_date |
string (date) | Leave empty for current affiliation |
is_primary |
boolean | |
affiliation_type |
string | Enum: employment, education, visiting, honorary, consulting |
created |
string (date-time) |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
- Model Source:
PatchedReviewerExpertiseRequest - API Source:
nested_reviewer_profile_expertise_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Name | Type | Required | Description |
|---|---|---|---|
reviewer_profile_uuid |
string | ✓ | UUID of the parent reviewer profile |
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
expertise_keyword |
string | Free-text keyword | |
expertise_category |
string (uuid) | ||
proficiency_level |
string | Enum: expert, familiar, basic |
|
years_experience |
integer | ||
last_active_date |
string (date) | When last worked in this area |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
expertise_keyword |
string | Free-text keyword |
expertise_category |
string (uuid) | |
expertise_category_name |
string | |
proficiency_level |
string | Enum: expert, familiar, basic |
years_experience |
integer | |
last_active_date |
string (date) | When last worked in this area |
created |
string (date-time) |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
- Model Source:
PatchedReviewerPublicationRequest - API Source:
nested_reviewer_profile_publications_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Name | Type | Required | Description |
|---|---|---|---|
reviewer_profile_uuid |
string | ✓ | UUID of the parent reviewer profile |
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
title |
string | ||
doi |
string | Digital Object Identifier | |
publication_year |
integer | ||
venue |
string | Journal or conference name | |
venue_type |
string | Enum: journal, conference, preprint, book, thesis, report, other |
|
abstract |
string | ||
coauthors |
any | List of co-author names and identifiers | |
external_ids |
any | External identifiers: | |
is_excluded_from_matching |
boolean | User can exclude old papers from expertise matching |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
title |
string | |
doi |
string | Digital Object Identifier |
publication_year |
integer | |
venue |
string | Journal or conference name |
venue_type |
string | Enum: journal, conference, preprint, book, thesis, report, other |
abstract |
string | |
coauthors |
any | List of co-author names and identifiers |
external_ids |
any | External identifiers: |
is_excluded_from_matching |
boolean | User can exclude old papers from expertise matching |
created |
string (date-time) |
Get or create reviewer profile for the current user
Get or create reviewer profile for the current user.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
- Model Source:
PatchedReviewerProfileCreateRequest - API Source:
reviewer_profiles_me_partial_update
1 2 3 4 5 6 7 8 9 10 | |
| Field | Type | Required | Description |
|---|---|---|---|
orcid_id |
string | ORCID identifier (format: 0000-0000-0000-0000) | |
biography |
string | Professional biography / summary | |
alternative_names |
any | List of name variants used in publications | |
available_for_reviews |
boolean | Whether reviewer is currently accepting review requests |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
user |
string (uri) | |
user_uuid |
string (uuid) | |
user_full_name |
string | |
user_email |
string (email) | |
orcid_id |
string | ORCID identifier (format: 0000-0000-0000-0000) |
orcid_connected |
boolean | Check if ORCID is connected (has access token). |
orcid_last_sync |
string (date-time) | |
biography |
string | Professional biography / summary |
alternative_names |
any | List of name variants used in publications |
affiliations |
array of objects | |
affiliations.uuid |
string (uuid) | |
affiliations.organization |
string (uuid) | |
affiliations.organization_name |
string | Organization name (used when not linked to Waldur org) |
affiliations.organization_name_display |
string | Return organization name from linked Customer or from the text field. |
affiliations.organization_identifier |
string | ROR, GRID, or other external identifier |
affiliations.department |
string | |
affiliations.position_title |
string | |
affiliations.start_date |
string (date) | |
affiliations.end_date |
string (date) | Leave empty for current affiliation |
affiliations.is_primary |
boolean | |
affiliations.affiliation_type |
string | Enum: employment, education, visiting, honorary, consulting |
affiliations.created |
string (date-time) | |
expertise_set |
array of objects | |
expertise_set.uuid |
string (uuid) | |
expertise_set.expertise_keyword |
string | Free-text keyword |
expertise_set.expertise_category |
string (uuid) | |
expertise_set.expertise_category_name |
string | |
expertise_set.proficiency_level |
string | Enum: expert, familiar, basic |
expertise_set.years_experience |
integer | |
expertise_set.last_active_date |
string (date) | When last worked in this area |
expertise_set.created |
string (date-time) | |
publications |
array of objects | |
publications.uuid |
string (uuid) | |
publications.title |
string | |
publications.doi |
string | Digital Object Identifier |
publications.publication_year |
integer | |
publications.venue |
string | Journal or conference name |
publications.venue_type |
string | Enum: journal, conference, preprint, book, thesis, report, other |
publications.abstract |
string | |
publications.coauthors |
any | List of co-author names and identifiers |
publications.external_ids |
any | External identifiers: |
publications.is_excluded_from_matching |
boolean | User can exclude old papers from expertise matching |
publications.created |
string (date-time) | |
stats |
any | |
profile_completeness |
object (free-form) | Calculate profile completeness percentage and missing fields. |
is_published |
boolean | Whether profile is discoverable by call managers |
published_at |
string (date-time) | When the profile was published |
available_for_reviews |
boolean | Whether reviewer is currently accepting review requests |
created |
string (date-time) | |
modified |
string (date-time) |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedReviewerProfileRequest - API Source:
reviewer_profiles_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
orcid_id |
string | ORCID identifier (format: 0000-0000-0000-0000) | |
biography |
string | Professional biography / summary | |
alternative_names |
any | List of name variants used in publications | |
available_for_reviews |
boolean | Whether reviewer is currently accepting review requests |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
user |
string (uri) | |
user_uuid |
string (uuid) | |
user_full_name |
string | |
user_email |
string (email) | |
orcid_id |
string | ORCID identifier (format: 0000-0000-0000-0000) |
orcid_connected |
boolean | Check if ORCID is connected (has access token). |
orcid_last_sync |
string (date-time) | |
biography |
string | Professional biography / summary |
alternative_names |
any | List of name variants used in publications |
affiliations |
array of objects | |
affiliations.uuid |
string (uuid) | |
affiliations.organization |
string (uuid) | |
affiliations.organization_name |
string | Organization name (used when not linked to Waldur org) |
affiliations.organization_name_display |
string | Return organization name from linked Customer or from the text field. |
affiliations.organization_identifier |
string | ROR, GRID, or other external identifier |
affiliations.department |
string | |
affiliations.position_title |
string | |
affiliations.start_date |
string (date) | |
affiliations.end_date |
string (date) | Leave empty for current affiliation |
affiliations.is_primary |
boolean | |
affiliations.affiliation_type |
string | Enum: employment, education, visiting, honorary, consulting |
affiliations.created |
string (date-time) | |
expertise_set |
array of objects | |
expertise_set.uuid |
string (uuid) | |
expertise_set.expertise_keyword |
string | Free-text keyword |
expertise_set.expertise_category |
string (uuid) | |
expertise_set.expertise_category_name |
string | |
expertise_set.proficiency_level |
string | Enum: expert, familiar, basic |
expertise_set.years_experience |
integer | |
expertise_set.last_active_date |
string (date) | When last worked in this area |
expertise_set.created |
string (date-time) | |
publications |
array of objects | |
publications.uuid |
string (uuid) | |
publications.title |
string | |
publications.doi |
string | Digital Object Identifier |
publications.publication_year |
integer | |
publications.venue |
string | Journal or conference name |
publications.venue_type |
string | Enum: journal, conference, preprint, book, thesis, report, other |
publications.abstract |
string | |
publications.coauthors |
any | List of co-author names and identifiers |
publications.external_ids |
any | External identifiers: |
publications.is_excluded_from_matching |
boolean | User can exclude old papers from expertise matching |
publications.created |
string (date-time) | |
stats |
any | |
profile_completeness |
object (free-form) | Calculate profile completeness percentage and missing fields. |
is_published |
boolean | Whether profile is discoverable by call managers |
published_at |
string (date-time) | When the profile was published |
available_for_reviews |
boolean | Whether reviewer is currently accepting review requests |
created |
string (date-time) | |
modified |
string (date-time) |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- API Source:
nested_reviewer_profile_affiliations_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Name | Type | Required | Description |
|---|---|---|---|
reviewer_profile_uuid |
string | ✓ | UUID of the parent reviewer profile |
uuid |
string (uuid) | ✓ |
204 - No response body
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- API Source:
nested_reviewer_profile_expertise_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Name | Type | Required | Description |
|---|---|---|---|
reviewer_profile_uuid |
string | ✓ | UUID of the parent reviewer profile |
uuid |
string (uuid) | ✓ |
204 - No response body
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- API Source:
nested_reviewer_profile_publications_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Name | Type | Required | Description |
|---|---|---|---|
reviewer_profile_uuid |
string | ✓ | UUID of the parent reviewer profile |
uuid |
string (uuid) | ✓ |
204 - No response body
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
reviewer_profiles_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Reviewer Suggestions
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/reviewer-suggestions/ |
List Reviewer Suggestions |
| GET | /api/reviewer-suggestions/{uuid}/ |
Retrieve |
| DELETE | /api/reviewer-suggestions/{uuid}/ |
Delete a reviewer suggestion |
| Other Actions | ||
| POST | /api/reviewer-suggestions/{uuid}/confirm/ |
Confirm a reviewer suggestion. The reviewer will be invited to the call |
| POST | /api/reviewer-suggestions/{uuid}/reject/ |
Reject a reviewer suggestion |
Core CRUD
List Reviewer Suggestions
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- Model Source:
ReviewerSuggestionOEnum - Model Source:
ReviewerSuggestionStatusEnum - API Source:
reviewer_suggestions_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
call_uuid |
string (uuid) | |
min_affinity_score |
number (float) | |
o |
array | Ordering |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
reviewer_uuid |
string (uuid) | |
status |
array |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
call |
string (uri) | |
call_uuid |
string (uuid) | |
call_name |
string | |
reviewer |
string (uri) | |
reviewer_uuid |
string (uuid) | |
reviewer_name |
string | |
reviewer_email |
string (email) | |
reviewer_biography |
string | Professional biography / summary |
affinity_score |
number (double) | Combined affinity score (0-1) |
keyword_score |
number (double) | Keyword matching score |
text_score |
number (double) | TF-IDF text similarity score |
status |
string | Enum: pending, confirmed, rejected, invited |
status_display |
string | |
reviewed_by |
string (uri) | |
reviewed_by_name |
string | |
reviewed_at |
string (date-time) | |
rejection_reason |
string | |
matched_keywords |
any | Keywords from reviewer's expertise that matched the source text |
top_matching_proposals |
any | Top proposals with highest affinity: [{uuid, name, slug, affinity}, ...] |
source_type |
any | What content was used to generate this suggestion |
source_type_display |
string | |
created |
string (date-time) |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
reviewer_suggestions_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
call |
string (uri) | |
call_uuid |
string (uuid) | |
call_name |
string | |
reviewer |
string (uri) | |
reviewer_uuid |
string (uuid) | |
reviewer_name |
string | |
reviewer_email |
string (email) | |
reviewer_biography |
string | Professional biography / summary |
affinity_score |
number (double) | Combined affinity score (0-1) |
keyword_score |
number (double) | Keyword matching score |
text_score |
number (double) | TF-IDF text similarity score |
status |
string | Enum: pending, confirmed, rejected, invited |
status_display |
string | |
reviewed_by |
string (uri) | |
reviewed_by_name |
string | |
reviewed_at |
string (date-time) | |
rejection_reason |
string | |
matched_keywords |
any | Keywords from reviewer's expertise that matched the source text |
top_matching_proposals |
any | Top proposals with highest affinity: [{uuid, name, slug, affinity}, ...] |
source_type |
any | What content was used to generate this suggestion |
source_type_display |
string | |
created |
string (date-time) |
Delete a reviewer suggestion
Delete a reviewer suggestion.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
reviewer_suggestions_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
Confirm a reviewer suggestion. The reviewer will be invited to the call
Confirm a reviewer suggestion. The reviewer will be invited to the call.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
ReviewerSuggestionRequest - API Source:
reviewer_suggestions_confirm
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
status |
string | |
rejection_reason |
string |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
call |
string (uri) | |
call_uuid |
string (uuid) | |
call_name |
string | |
reviewer |
string (uri) | |
reviewer_uuid |
string (uuid) | |
reviewer_name |
string | |
reviewer_email |
string (email) | |
reviewer_biography |
string | Professional biography / summary |
affinity_score |
number (double) | Combined affinity score (0-1) |
keyword_score |
number (double) | Keyword matching score |
text_score |
number (double) | TF-IDF text similarity score |
status |
string | Enum: pending, confirmed, rejected, invited |
status_display |
string | |
reviewed_by |
string (uri) | |
reviewed_by_name |
string | |
reviewed_at |
string (date-time) | |
rejection_reason |
string | |
matched_keywords |
any | Keywords from reviewer's expertise that matched the source text |
top_matching_proposals |
any | Top proposals with highest affinity: [{uuid, name, slug, affinity}, ...] |
source_type |
any | What content was used to generate this suggestion |
source_type_display |
string | |
created |
string (date-time) |
Reject a reviewer suggestion
Reject a reviewer suggestion.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
SuggestionRejectRequest - API Source:
reviewer_suggestions_reject
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
reason |
string | Reason for rejecting the suggestion |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
call |
string (uri) | |
call_uuid |
string (uuid) | |
call_name |
string | |
reviewer |
string (uri) | |
reviewer_uuid |
string (uuid) | |
reviewer_name |
string | |
reviewer_email |
string (email) | |
reviewer_biography |
string | Professional biography / summary |
affinity_score |
number (double) | Combined affinity score (0-1) |
keyword_score |
number (double) | Keyword matching score |
text_score |
number (double) | TF-IDF text similarity score |
status |
string | Enum: pending, confirmed, rejected, invited |
status_display |
string | |
reviewed_by |
string (uri) | |
reviewed_by_name |
string | |
reviewed_at |
string (date-time) | |
rejection_reason |
string | |
matched_keywords |
any | Keywords from reviewer's expertise that matched the source text |
top_matching_proposals |
any | Top proposals with highest affinity: [{uuid, name, slug, affinity}, ...] |
source_type |
any | What content was used to generate this suggestion |
source_type_display |
string | |
created |
string (date-time) |
Proposal Reviews
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/proposal-reviews/ |
List Proposal Reviews |
| GET | /api/proposal-reviews/{uuid}/ |
Retrieve |
| POST | /api/proposal-reviews/ |
Create |
| PUT | /api/proposal-reviews/{uuid}/ |
Update |
| PATCH | /api/proposal-reviews/{uuid}/ |
Partial Update |
| DELETE | /api/proposal-reviews/{uuid}/ |
Delete |
| Other Actions | ||
| POST | /api/proposal-reviews/{uuid}/reject/ |
Reject a review, changing its state to REJECTED |
| POST | /api/proposal-reviews/{uuid}/submit/ |
Submit a review, changing its state to SUBMITTED |
Core CRUD
List Proposal Reviews
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- Model Source:
ProposalReviewOEnum - Model Source:
ProposalReviewStateEnum - API Source:
proposal_reviews_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
call_uuid |
string (uuid) | |
o |
array | Ordering |
organization_uuid |
string (uuid) | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
proposal |
string (uri) | |
proposal_name |
string | |
proposal_uuid |
string (uuid) | |
reviewer_uuid |
string (uuid) | |
round_uuid |
string (uuid) | |
state |
array |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
proposal |
string (uri) | |
proposal_name |
string | |
proposal_uuid |
string (uuid) | |
proposal_slug |
string | |
reviewer |
string (uri) | |
reviewer_full_name |
string | |
reviewer_uuid |
string (uuid) | |
anonymous_reviewer_name |
string | Generate an anonymous reviewer identifier like 'Reviewer 1', 'Reviewer 2'. Returns None if the review is not associated with a proposal. |
state |
any | |
review_end_date |
string (date-time) | |
summary_score |
integer | |
summary_public_comment |
string | |
summary_private_comment |
string | |
round_uuid |
string (uuid) | |
round_name |
string | |
round_slug |
string | |
round_cutoff_time |
string (date-time) | |
round_start_time |
string (date-time) | |
call_name |
string | |
call_uuid |
string (uuid) | |
call_slug |
string | |
call_managing_organisation_uuid |
string (uuid) | |
comment_project_title |
string | |
comment_project_summary |
string | |
comment_project_is_confidential |
string | |
comment_project_has_civilian_purpose |
string | |
comment_project_description |
string | |
comment_project_duration |
string | |
comment_project_supporting_documentation |
string | |
comment_resource_requests |
string | |
comment_team |
string | |
created |
string (date-time) | |
modified |
string (date-time) |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
proposal_reviews_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
proposal |
string (uri) | |
proposal_name |
string | |
proposal_uuid |
string (uuid) | |
proposal_slug |
string | |
reviewer |
string (uri) | |
reviewer_full_name |
string | |
reviewer_uuid |
string (uuid) | |
anonymous_reviewer_name |
string | Generate an anonymous reviewer identifier like 'Reviewer 1', 'Reviewer 2'. Returns None if the review is not associated with a proposal. |
state |
any | |
review_end_date |
string (date-time) | |
summary_score |
integer | |
summary_public_comment |
string | |
summary_private_comment |
string | |
round_uuid |
string (uuid) | |
round_name |
string | |
round_slug |
string | |
round_cutoff_time |
string (date-time) | |
round_start_time |
string (date-time) | |
call_name |
string | |
call_uuid |
string (uuid) | |
call_slug |
string | |
call_managing_organisation_uuid |
string (uuid) | |
comment_project_title |
string | |
comment_project_summary |
string | |
comment_project_is_confidential |
string | |
comment_project_has_civilian_purpose |
string | |
comment_project_description |
string | |
comment_project_duration |
string | |
comment_project_supporting_documentation |
string | |
comment_resource_requests |
string | |
comment_team |
string | |
created |
string (date-time) | |
modified |
string (date-time) |
Create
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
- Model Source:
ProposalReviewRequest - API Source:
proposal_reviews_create
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Field | Type | Required |
|---|---|---|
proposal |
string (uri) | ✓ |
reviewer |
string (uri) | |
summary_score |
integer | |
summary_public_comment |
string | |
summary_private_comment |
string | |
comment_project_title |
string | |
comment_project_summary |
string | |
comment_project_is_confidential |
string | |
comment_project_has_civilian_purpose |
string | |
comment_project_description |
string | |
comment_project_duration |
string | |
comment_project_supporting_documentation |
string | |
comment_resource_requests |
string | |
comment_team |
string |
201 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
proposal |
string (uri) | |
proposal_name |
string | |
proposal_uuid |
string (uuid) | |
proposal_slug |
string | |
reviewer |
string (uri) | |
reviewer_full_name |
string | |
reviewer_uuid |
string (uuid) | |
anonymous_reviewer_name |
string | Generate an anonymous reviewer identifier like 'Reviewer 1', 'Reviewer 2'. Returns None if the review is not associated with a proposal. |
state |
any | |
review_end_date |
string (date-time) | |
summary_score |
integer | |
summary_public_comment |
string | |
summary_private_comment |
string | |
round_uuid |
string (uuid) | |
round_name |
string | |
round_slug |
string | |
round_cutoff_time |
string (date-time) | |
round_start_time |
string (date-time) | |
call_name |
string | |
call_uuid |
string (uuid) | |
call_slug |
string | |
call_managing_organisation_uuid |
string (uuid) | |
comment_project_title |
string | |
comment_project_summary |
string | |
comment_project_is_confidential |
string | |
comment_project_has_civilian_purpose |
string | |
comment_project_description |
string | |
comment_project_duration |
string | |
comment_project_supporting_documentation |
string | |
comment_resource_requests |
string | |
comment_team |
string | |
created |
string (date-time) | |
modified |
string (date-time) |
Update
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
ProposalReviewRequest - API Source:
proposal_reviews_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
proposal |
string (uri) | ✓ |
reviewer |
string (uri) | |
summary_score |
integer | |
summary_public_comment |
string | |
summary_private_comment |
string | |
comment_project_title |
string | |
comment_project_summary |
string | |
comment_project_is_confidential |
string | |
comment_project_has_civilian_purpose |
string | |
comment_project_description |
string | |
comment_project_duration |
string | |
comment_project_supporting_documentation |
string | |
comment_resource_requests |
string | |
comment_team |
string |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
proposal |
string (uri) | |
proposal_name |
string | |
proposal_uuid |
string (uuid) | |
proposal_slug |
string | |
reviewer |
string (uri) | |
reviewer_full_name |
string | |
reviewer_uuid |
string (uuid) | |
anonymous_reviewer_name |
string | Generate an anonymous reviewer identifier like 'Reviewer 1', 'Reviewer 2'. Returns None if the review is not associated with a proposal. |
state |
any | |
review_end_date |
string (date-time) | |
summary_score |
integer | |
summary_public_comment |
string | |
summary_private_comment |
string | |
round_uuid |
string (uuid) | |
round_name |
string | |
round_slug |
string | |
round_cutoff_time |
string (date-time) | |
round_start_time |
string (date-time) | |
call_name |
string | |
call_uuid |
string (uuid) | |
call_slug |
string | |
call_managing_organisation_uuid |
string (uuid) | |
comment_project_title |
string | |
comment_project_summary |
string | |
comment_project_is_confidential |
string | |
comment_project_has_civilian_purpose |
string | |
comment_project_description |
string | |
comment_project_duration |
string | |
comment_project_supporting_documentation |
string | |
comment_resource_requests |
string | |
comment_team |
string | |
created |
string (date-time) | |
modified |
string (date-time) |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedProposalReviewRequest - API Source:
proposal_reviews_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
summary_score |
integer | |
summary_public_comment |
string | |
summary_private_comment |
string | |
comment_project_title |
string | |
comment_project_summary |
string | |
comment_project_is_confidential |
string | |
comment_project_has_civilian_purpose |
string | |
comment_project_description |
string | |
comment_project_duration |
string | |
comment_project_supporting_documentation |
string | |
comment_resource_requests |
string | |
comment_team |
string |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
proposal |
string (uri) | |
proposal_name |
string | |
proposal_uuid |
string (uuid) | |
proposal_slug |
string | |
reviewer |
string (uri) | |
reviewer_full_name |
string | |
reviewer_uuid |
string (uuid) | |
anonymous_reviewer_name |
string | Generate an anonymous reviewer identifier like 'Reviewer 1', 'Reviewer 2'. Returns None if the review is not associated with a proposal. |
state |
any | |
review_end_date |
string (date-time) | |
summary_score |
integer | |
summary_public_comment |
string | |
summary_private_comment |
string | |
round_uuid |
string (uuid) | |
round_name |
string | |
round_slug |
string | |
round_cutoff_time |
string (date-time) | |
round_start_time |
string (date-time) | |
call_name |
string | |
call_uuid |
string (uuid) | |
call_slug |
string | |
call_managing_organisation_uuid |
string (uuid) | |
comment_project_title |
string | |
comment_project_summary |
string | |
comment_project_is_confidential |
string | |
comment_project_has_civilian_purpose |
string | |
comment_project_description |
string | |
comment_project_duration |
string | |
comment_project_supporting_documentation |
string | |
comment_resource_requests |
string | |
comment_team |
string | |
created |
string (date-time) | |
modified |
string (date-time) |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
proposal_reviews_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
Reject a review, changing its state to REJECTED
Reject a review, changing its state to REJECTED.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
proposal_reviews_reject
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 - No response body
Submit a review, changing its state to SUBMITTED
Submit a review, changing its state to SUBMITTED.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
ReviewSubmitRequest - API Source:
proposal_reviews_submit
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
summary_score |
integer | |
summary_public_comment |
string | |
summary_private_comment |
string |
200 - No response body
Support and operations
Feedback and statistics
Support Feedback Average Report
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/support-feedback-average-report/ |
List Support Feedback Average Report |
List Support Feedback Average Report
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
- API Source:
support_feedback_average_report_retrieve
1 2 3 4 5 6 7 8 9 10 | |
200 - No response body
Support Feedback Report
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/support-feedback-report/ |
List Support Feedback Report |
List Support Feedback Report
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
- API Source:
support_feedback_report_retrieve
1 2 3 4 5 6 7 8 9 10 | |
200 - No response body
Support Feedbacks
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/support-feedbacks/ |
List Support Feedbacks |
| GET | /api/support-feedbacks/{uuid}/ |
Retrieve |
| POST | /api/support-feedbacks/ |
Create |
List Support Feedbacks
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
support_feedbacks_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
created_after |
string (date-time) | |
created_before |
string (date-time) | |
evaluation |
integer | |
issue |
string (uri) | |
issue_key |
string | |
issue_uuid |
string (uuid) | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
user |
string (uri) | |
user_full_name |
string | User full name contains |
user_uuid |
string (uuid) |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
uuid |
string (uuid) |
created |
string (date-time) |
modified |
string (date-time) |
state |
any |
evaluation |
integer |
comment |
string |
issue_uuid |
string (uuid) |
user_full_name |
string |
issue_key |
string |
issue_summary |
string |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
support_feedbacks_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
created |
string (date-time) |
modified |
string (date-time) |
state |
any |
evaluation |
integer |
comment |
string |
issue_uuid |
string (uuid) |
user_full_name |
string |
issue_key |
string |
issue_summary |
string |
Create
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
CreateFeedbackRequest - API Source:
support_feedbacks_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Field | Type | Required |
|---|---|---|
comment |
string | |
evaluation |
integer | ✓ |
token |
string | ✓ |
201 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
issue |
string (uri) |
comment |
string |
evaluation |
integer |
Support Statistics
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/support-statistics/ |
List Support Statistics |
List Support Statistics
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
- API Source:
support_statistics_retrieve
1 2 3 4 5 6 7 8 9 10 | |
200 -
| Field | Type |
|---|---|
open_issues_count |
integer |
closed_this_month_count |
integer |
recent_broadcasts_count |
integer |
Support and issues
Support Attachments
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/support-attachments/ |
List Support Attachments |
| GET | /api/support-attachments/{uuid}/ |
Retrieve |
| POST | /api/support-attachments/ |
Create |
| DELETE | /api/support-attachments/{uuid}/ |
Delete |
List Support Attachments
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 | |
- Model Source:
AttachmentFieldEnum - API Source:
support_attachments_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
field |
array | |
issue |
string (uri) | |
issue_uuid |
string (uuid) | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
issue |
string (uri) |
issue_key |
string |
created |
string (date-time) |
file |
string (uri) |
mime_type |
string |
file_size |
integer |
file_name |
string |
backend_id |
string |
destroy_is_available |
boolean |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
AttachmentFieldEnum - API Source:
support_attachments_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
issue |
string (uri) |
issue_key |
string |
created |
string (date-time) |
file |
string (uri) |
mime_type |
string |
file_size |
integer |
file_name |
string |
backend_id |
string |
destroy_is_available |
boolean |
Create
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
AttachmentRequest - API Source:
support_attachments_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Field | Type | Required |
|---|---|---|
issue |
string (uri) | ✓ |
file |
string (binary) | ✓ |
201 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
issue |
string (uri) |
issue_key |
string |
created |
string (date-time) |
file |
string (uri) |
mime_type |
string |
file_size |
integer |
file_name |
string |
backend_id |
string |
destroy_is_available |
boolean |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
support_attachments_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Chat Quota
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/chat-quota/usage/ |
List Chat Quota Usage |
| POST | /api/chat-quota/set_quota/ |
Set token quota for user |
List Chat Quota Usage
1 2 3 4 5 6 7 8 | |
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
chat_quota_usage_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required | Description |
|---|---|---|---|
user_uuid |
string (uuid) | ✓ | UUID of user to view quota for (staff/support only). Omit to view your own quota. |
200 -
| Field | Type | Description |
|---|---|---|
daily_limit |
integer | Daily token limit (non-negative integer). Null uses system default. -1 means unlimited. |
daily_usage |
integer | |
daily_remaining |
integer | Get remaining daily tokens. |
daily_reset_at |
string (date-time) | Calculate next midnight (00:00:00). |
daily_system_default |
integer | Get system default daily token limit from constance config. |
weekly_limit |
integer | Weekly token limit (non-negative integer). Null uses system default. -1 means unlimited. |
weekly_usage |
integer | |
weekly_remaining |
integer | Get remaining weekly tokens. |
weekly_reset_at |
string (date-time) | Calculate next Monday at midnight. |
weekly_system_default |
integer | Get system default weekly token limit from constance config. |
monthly_limit |
integer | Monthly token limit (non-negative integer). Null uses system default. -1 means unlimited. |
monthly_usage |
integer | |
monthly_remaining |
integer | Get remaining monthly tokens. |
monthly_reset_at |
string (date-time) | Calculate first day of next month at midnight. |
monthly_system_default |
integer | Get system default monthly token limit from constance config. |
Set token quota for user
Allows staff/support to set token quota limits for a specific user. Configure daily, weekly, and monthly limits:
- Omit field or send null: Use system default
- -1: Unlimited (no quota enforcement)
- 0 or positive integer: Specific token limit
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
- Model Source:
SetTokenQuotaRequest - API Source:
chat_quota_set_quota
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Field | Type | Required | Description |
|---|---|---|---|
user_uuid |
string (uuid) | ✓ | UUID of the user to set quota for. |
daily_limit |
integer | Daily token limit. Omit or null = system default, -1 = unlimited. | |
weekly_limit |
integer | Weekly token limit. Omit or null = system default, -1 = unlimited. | |
monthly_limit |
integer | Monthly token limit. Omit or null = system default, -1 = unlimited. |
200 - No response body
Chat Tools
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| POST | /api/chat-tools/execute/ |
Execute a tool and return the result |
Execute a tool and return the result
Execute a tool and return the result.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
- Model Source:
ToolExecuteRequest - API Source:
chat_tools_execute
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Field | Type | Required | Description |
|---|---|---|---|
tool |
string | ✓ | Name of the tool to execute. |
arguments |
any | Tool arguments. |
200 -
Chat
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/chat-messages/ |
List Chat Messages |
| GET | /api/chat-sessions/current/ |
Get or create current user's chat session |
| GET | /api/chat-sessions/ |
List Chat Sessions |
| GET | /api/chat-sessions/{uuid}/ |
Retrieve |
| GET | /api/chat-threads/ |
List Chat Threads |
| GET | /api/chat-threads/{uuid}/ |
Retrieve |
| POST | /api/chat/stream/ |
Stream |
| POST | /api/chat-threads/{uuid}/archive/ |
Archive thread |
| POST | /api/chat-threads/{uuid}/unarchive/ |
Unarchive thread |
List Chat Messages
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
chat_messages_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type |
|---|---|
include_history |
boolean |
is_flagged |
boolean |
thread |
string (uuid) |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
uuid |
string (uuid) |
thread |
string (uuid) |
role |
any |
content |
string |
sequence_index |
integer |
replaces |
string (uuid) |
created |
string (date-time) |
is_flagged |
boolean |
injection_score |
number (double) |
injection_severity |
any |
injection_categories |
any |
Get or create current user's chat session
Returns the current user's chat session, creating it if it doesn't exist.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
- API Source:
chat_sessions_current_retrieve
1 2 3 4 5 6 7 8 9 10 | |
200 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
user |
string (uuid) |
user_username |
string |
user_full_name |
string |
created |
string (date-time) |
modified |
string (date-time) |
List Chat Sessions
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 | |
- Model Source:
ChatSessionFieldEnum - API Source:
chat_sessions_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
field |
array | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
uuid |
string (uuid) |
user |
string (uuid) |
user_username |
string |
user_full_name |
string |
created |
string (date-time) |
modified |
string (date-time) |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
ChatSessionFieldEnum - API Source:
chat_sessions_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
user |
string (uuid) |
user_username |
string |
user_full_name |
string |
created |
string (date-time) |
modified |
string (date-time) |
List Chat Threads
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
InjectionSeverityEnum - Model Source:
ThreadSessionFieldEnum - Model Source:
ThreadSessionOEnum - API Source:
chat_threads_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
created |
string (date) | |
field |
array | |
is_archived |
boolean | |
is_flagged |
boolean | |
max_severity |
string | Enum: none, low, medium, high, critical |
modified |
string (date) | |
o |
array | Ordering |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
query |
string | |
user |
string (uuid) |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
uuid |
string (uuid) |
name |
string |
chat_session |
string (uuid) |
flags |
any |
is_archived |
boolean |
message_count |
integer |
is_flagged |
boolean |
max_severity |
any |
user_username |
string |
user_full_name |
string |
created |
string (date-time) |
modified |
string (date-time) |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
ThreadSessionFieldEnum - API Source:
chat_threads_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Name | Type |
|---|---|
field |
array |
200 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
name |
string |
chat_session |
string (uuid) |
flags |
any |
is_archived |
boolean |
message_count |
integer |
is_flagged |
boolean |
max_severity |
any |
user_username |
string |
user_full_name |
string |
created |
string (date-time) |
modified |
string (date-time) |
Stream
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
- Model Source:
ChatRequestRequest - API Source:
chat_stream
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Field | Type | Required | Description |
|---|---|---|---|
input |
string | ✓ | User input text for the chat model. |
thread_uuid |
string (uuid) | Existing thread UUID. If omitted, a new thread is created. | |
update_thread_name |
string (uuid) | Thread UUID whose name should be set to the assistant's response. Skips message persistence for this call. | |
mode |
any | 'reload': replace the last assistant response. 'edit': edit a user message and re-stream. Omit for normal new-message behavior. | |
edit_message_uuid |
string (uuid) | UUID of the user message to edit. Required when mode='edit'. |
200 -
Archive thread
Archive a thread (soft delete).
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
ThreadSessionRequest - API Source:
chat_threads_archive
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
name |
string | |
is_archived |
boolean |
204 - No response body
Unarchive thread
Restore an archived thread.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
ThreadSessionRequest - API Source:
chat_threads_unarchive
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
name |
string | |
is_archived |
boolean |
204 - No response body
Support Comments
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/support-comments/ |
List Support Comments |
| GET | /api/support-comments/{uuid}/ |
Retrieve |
| PUT | /api/support-comments/{uuid}/ |
Update |
| PATCH | /api/support-comments/{uuid}/ |
Partial Update |
| DELETE | /api/support-comments/{uuid}/ |
Delete |
List Support Comments
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 | |
- Model Source:
ThreadSessionOEnum - API Source:
support_comments_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
author_name |
string | |
author_user |
string (uri) | |
description |
string | |
is_public |
boolean | |
issue |
string (uri) | |
issue_uuid |
string (uuid) | |
o |
array | Ordering |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
remote_id_is_set |
boolean | Remote ID is set. |
resource |
string (uri) | Filter by resource URL. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
issue |
string (uri) |
issue_key |
string |
description |
string |
is_public |
boolean |
author_name |
string |
author_uuid |
string (uuid) |
author_user |
string (uri) |
author_email |
string (email) |
backend_id |
string |
remote_id |
string |
created |
string (date-time) |
update_is_available |
boolean |
destroy_is_available |
boolean |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
support_comments_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
issue |
string (uri) |
issue_key |
string |
description |
string |
is_public |
boolean |
author_name |
string |
author_uuid |
string (uuid) |
author_user |
string (uri) |
author_email |
string (email) |
backend_id |
string |
remote_id |
string |
created |
string (date-time) |
update_is_available |
boolean |
destroy_is_available |
boolean |
Update
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
CommentRequest - API Source:
support_comments_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
description |
string | ✓ |
is_public |
boolean |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
issue |
string (uri) |
issue_key |
string |
description |
string |
is_public |
boolean |
author_name |
string |
author_uuid |
string (uuid) |
author_user |
string (uri) |
author_email |
string (email) |
backend_id |
string |
remote_id |
string |
created |
string (date-time) |
update_is_available |
boolean |
destroy_is_available |
boolean |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedCommentRequest - API Source:
support_comments_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
description |
string | |
is_public |
boolean |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
issue |
string (uri) |
issue_key |
string |
description |
string |
is_public |
boolean |
author_name |
string |
author_uuid |
string (uuid) |
author_user |
string (uri) |
author_email |
string (email) |
backend_id |
string |
remote_id |
string |
created |
string (date-time) |
update_is_available |
boolean |
destroy_is_available |
boolean |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
support_comments_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Support Issue Statuses
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/support-issue-statuses/ |
List Support Issue Statuses |
| GET | /api/support-issue-statuses/{uuid}/ |
Retrieve |
| POST | /api/support-issue-statuses/ |
Create |
| PUT | /api/support-issue-statuses/{uuid}/ |
Update |
| PATCH | /api/support-issue-statuses/{uuid}/ |
Partial Update |
| DELETE | /api/support-issue-statuses/{uuid}/ |
Delete |
List Support Issue Statuses
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
support_issue_statuses_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | Status name in Jira. |
type |
any | |
type_display |
string |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
support_issue_statuses_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | Status name in Jira. |
type |
any | |
type_display |
string |
Create
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
- Model Source:
IssueStatusCreateRequest - API Source:
support_issue_statuses_create
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ✓ | Status name in Jira. |
type |
any |
201 -
| Field | Type | Description |
|---|---|---|
name |
string | Status name in Jira. |
type |
any |
Update
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
IssueStatusCreateRequest - API Source:
support_issue_statuses_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ✓ | Status name in Jira. |
type |
any |
200 -
| Field | Type | Description |
|---|---|---|
name |
string | Status name in Jira. |
type |
any |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedIssueStatusRequest - API Source:
support_issue_statuses_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | Status name in Jira. | |
type |
any |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | Status name in Jira. |
type |
any | |
type_display |
string |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
support_issue_statuses_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Support Issues
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/support-issues/ |
List Support Issues |
| GET | /api/support-issues/{uuid}/ |
Retrieve |
| POST | /api/support-issues/ |
Create |
| PUT | /api/support-issues/{uuid}/ |
Update |
| PATCH | /api/support-issues/{uuid}/ |
Partial Update |
| DELETE | /api/support-issues/{uuid}/ |
Delete |
| Other Actions | ||
| POST | /api/support-issues/{uuid}/comment/ |
Comment |
| POST | /api/support-issues/{uuid}/sync/ |
Sync |
Core CRUD
List Support Issues
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 | |
- Model Source:
IssueOEnum - API Source:
support_issues_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
assignee |
string (uri) | |
assignee_name |
string | |
caller |
string (uri) | |
caller_full_name |
string | Caller full name contains |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
key |
string | |
o |
array | Ordering |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
project |
string (uri) | |
project_uuid |
string (uuid) | |
query |
string | Summary or key contains |
remote_id |
string | |
reporter |
string (uri) | |
reporter_name |
string | |
resolution_year_month |
string | |
resource |
string (uri) | Filter by resource URL. |
resource_external_ip |
string | Resource external IP |
resource_internal_ip |
string | Resource internal IP |
resource_uuid |
string (uuid) | Resource UUID |
status |
string | |
summary |
string | |
type |
string |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
type |
string | |
key |
string | |
backend_id |
string | |
backend_name |
string | |
remote_id |
string | |
link |
string (uri) | Link to issue in support system. |
summary |
string | |
description |
string | |
status |
string | |
resolution |
string | |
priority |
string | |
caller |
string (uri) | |
caller_uuid |
string (uuid) | |
caller_full_name |
string | |
reporter |
string (uri) | |
reporter_uuid |
string (uuid) | |
reporter_name |
string | |
assignee |
string (uri) | |
assignee_uuid |
string (uuid) | |
assignee_name |
string | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
project |
string (uri) | |
project_uuid |
string (uuid) | |
project_name |
string | |
resource |
string | |
resource_type |
string | |
resource_name |
string | |
created |
string (date-time) | |
modified |
string (date-time) | |
template |
string (uri) | |
feedback |
any | |
resolved |
boolean | |
update_is_available |
boolean | |
destroy_is_available |
boolean | |
add_comment_is_available |
boolean | |
add_attachment_is_available |
boolean | |
processing_log |
any | Internal processing log for debugging order lifecycle events. Visible only to staff. |
order_uuid |
string | Return order UUID if the issue's resource is an Order. |
order_project_uuid |
string | Return order's project UUID if the issue's resource is an Order. |
order_customer_uuid |
string | Return order's customer UUID if the issue's resource is an Order. |
order_resource_name |
string | Return order's resource name if the issue's resource is an Order. |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
support_issues_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
type |
string | |
key |
string | |
backend_id |
string | |
backend_name |
string | |
remote_id |
string | |
link |
string (uri) | Link to issue in support system. |
summary |
string | |
description |
string | |
status |
string | |
resolution |
string | |
priority |
string | |
caller |
string (uri) | |
caller_uuid |
string (uuid) | |
caller_full_name |
string | |
reporter |
string (uri) | |
reporter_uuid |
string (uuid) | |
reporter_name |
string | |
assignee |
string (uri) | |
assignee_uuid |
string (uuid) | |
assignee_name |
string | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
project |
string (uri) | |
project_uuid |
string (uuid) | |
project_name |
string | |
resource |
string | |
resource_type |
string | |
resource_name |
string | |
created |
string (date-time) | |
modified |
string (date-time) | |
template |
string (uri) | |
feedback |
any | |
resolved |
boolean | |
update_is_available |
boolean | |
destroy_is_available |
boolean | |
add_comment_is_available |
boolean | |
add_attachment_is_available |
boolean | |
processing_log |
any | Internal processing log for debugging order lifecycle events. Visible only to staff. |
order_uuid |
string | Return order UUID if the issue's resource is an Order. |
order_project_uuid |
string | Return order's project UUID if the issue's resource is an Order. |
order_customer_uuid |
string | Return order's customer UUID if the issue's resource is an Order. |
order_resource_name |
string | Return order's resource name if the issue's resource is an Order. |
Create
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
IssueRequest - API Source:
support_issues_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Field | Type | Required | Description |
|---|---|---|---|
type |
string | ✓ | |
remote_id |
string | ||
summary |
string | ✓ | |
description |
string | ||
priority |
string | ||
caller |
string (uri) | ||
assignee |
string (uri) | ||
customer |
string (uri) | ||
project |
string (uri) | ||
resource |
string | ||
is_reported_manually |
boolean | Set true if issue is created by regular user via portal. Constraints: write-only, default: False |
|
template |
string (uri) |
201 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
type |
string | |
key |
string | |
backend_id |
string | |
backend_name |
string | |
remote_id |
string | |
link |
string (uri) | Link to issue in support system. |
summary |
string | |
description |
string | |
status |
string | |
resolution |
string | |
priority |
string | |
caller |
string (uri) | |
caller_uuid |
string (uuid) | |
caller_full_name |
string | |
reporter |
string (uri) | |
reporter_uuid |
string (uuid) | |
reporter_name |
string | |
assignee |
string (uri) | |
assignee_uuid |
string (uuid) | |
assignee_name |
string | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
project |
string (uri) | |
project_uuid |
string (uuid) | |
project_name |
string | |
resource |
string | |
resource_type |
string | |
resource_name |
string | |
created |
string (date-time) | |
modified |
string (date-time) | |
template |
string (uri) | |
feedback |
any | |
resolved |
boolean | |
update_is_available |
boolean | |
destroy_is_available |
boolean | |
add_comment_is_available |
boolean | |
add_attachment_is_available |
boolean | |
processing_log |
any | Internal processing log for debugging order lifecycle events. Visible only to staff. |
order_uuid |
string | Return order UUID if the issue's resource is an Order. |
order_project_uuid |
string | Return order's project UUID if the issue's resource is an Order. |
order_customer_uuid |
string | Return order's customer UUID if the issue's resource is an Order. |
order_resource_name |
string | Return order's resource name if the issue's resource is an Order. |
Update
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
IssueRequest - API Source:
support_issues_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
type |
string | ✓ | |
remote_id |
string | ||
summary |
string | ✓ | |
description |
string | ||
priority |
string | ||
caller |
string (uri) | ||
assignee |
string (uri) | ||
customer |
string (uri) | ||
project |
string (uri) | ||
resource |
string | ||
is_reported_manually |
boolean | Set true if issue is created by regular user via portal. Constraints: write-only, default: False |
|
template |
string (uri) |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
type |
string | |
key |
string | |
backend_id |
string | |
backend_name |
string | |
remote_id |
string | |
link |
string (uri) | Link to issue in support system. |
summary |
string | |
description |
string | |
status |
string | |
resolution |
string | |
priority |
string | |
caller |
string (uri) | |
caller_uuid |
string (uuid) | |
caller_full_name |
string | |
reporter |
string (uri) | |
reporter_uuid |
string (uuid) | |
reporter_name |
string | |
assignee |
string (uri) | |
assignee_uuid |
string (uuid) | |
assignee_name |
string | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
project |
string (uri) | |
project_uuid |
string (uuid) | |
project_name |
string | |
resource |
string | |
resource_type |
string | |
resource_name |
string | |
created |
string (date-time) | |
modified |
string (date-time) | |
template |
string (uri) | |
feedback |
any | |
resolved |
boolean | |
update_is_available |
boolean | |
destroy_is_available |
boolean | |
add_comment_is_available |
boolean | |
add_attachment_is_available |
boolean | |
processing_log |
any | Internal processing log for debugging order lifecycle events. Visible only to staff. |
order_uuid |
string | Return order UUID if the issue's resource is an Order. |
order_project_uuid |
string | Return order's project UUID if the issue's resource is an Order. |
order_customer_uuid |
string | Return order's customer UUID if the issue's resource is an Order. |
order_resource_name |
string | Return order's resource name if the issue's resource is an Order. |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedIssueRequest - API Source:
support_issues_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
summary |
string | ||
description |
string | ||
assignee |
string (uri) | ||
is_reported_manually |
boolean | Set true if issue is created by regular user via portal. Constraints: write-only, default: False |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
type |
string | |
key |
string | |
backend_id |
string | |
backend_name |
string | |
remote_id |
string | |
link |
string (uri) | Link to issue in support system. |
summary |
string | |
description |
string | |
status |
string | |
resolution |
string | |
priority |
string | |
caller |
string (uri) | |
caller_uuid |
string (uuid) | |
caller_full_name |
string | |
reporter |
string (uri) | |
reporter_uuid |
string (uuid) | |
reporter_name |
string | |
assignee |
string (uri) | |
assignee_uuid |
string (uuid) | |
assignee_name |
string | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
project |
string (uri) | |
project_uuid |
string (uuid) | |
project_name |
string | |
resource |
string | |
resource_type |
string | |
resource_name |
string | |
created |
string (date-time) | |
modified |
string (date-time) | |
template |
string (uri) | |
feedback |
any | |
resolved |
boolean | |
update_is_available |
boolean | |
destroy_is_available |
boolean | |
add_comment_is_available |
boolean | |
add_attachment_is_available |
boolean | |
processing_log |
any | Internal processing log for debugging order lifecycle events. Visible only to staff. |
order_uuid |
string | Return order UUID if the issue's resource is an Order. |
order_project_uuid |
string | Return order's project UUID if the issue's resource is an Order. |
order_customer_uuid |
string | Return order's customer UUID if the issue's resource is an Order. |
order_resource_name |
string | Return order's resource name if the issue's resource is an Order. |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
support_issues_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
Comment
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
CommentRequest - API Source:
support_issues_comment
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
description |
string | ✓ |
is_public |
boolean |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
issue |
string (uri) |
issue_key |
string |
description |
string |
is_public |
boolean |
author_name |
string |
author_uuid |
string (uuid) |
author_user |
string (uri) |
author_email |
string (email) |
backend_id |
string |
remote_id |
string |
created |
string (date-time) |
update_is_available |
boolean |
destroy_is_available |
boolean |
Sync
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
IssueRequest - API Source:
support_issues_sync
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
type |
string | ✓ | |
remote_id |
string | ||
summary |
string | ✓ | |
description |
string | ||
priority |
string | ||
caller |
string (uri) | ||
assignee |
string (uri) | ||
customer |
string (uri) | ||
project |
string (uri) | ||
resource |
string | ||
is_reported_manually |
boolean | Set true if issue is created by regular user via portal. Constraints: write-only, default: False |
|
template |
string (uri) |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
type |
string | |
key |
string | |
backend_id |
string | |
backend_name |
string | |
remote_id |
string | |
link |
string (uri) | Link to issue in support system. |
summary |
string | |
description |
string | |
status |
string | |
resolution |
string | |
priority |
string | |
caller |
string (uri) | |
caller_uuid |
string (uuid) | |
caller_full_name |
string | |
reporter |
string (uri) | |
reporter_uuid |
string (uuid) | |
reporter_name |
string | |
assignee |
string (uri) | |
assignee_uuid |
string (uuid) | |
assignee_name |
string | |
customer |
string (uri) | |
customer_uuid |
string (uuid) | |
customer_name |
string | |
project |
string (uri) | |
project_uuid |
string (uuid) | |
project_name |
string | |
resource |
string | |
resource_type |
string | |
resource_name |
string | |
created |
string (date-time) | |
modified |
string (date-time) | |
template |
string (uri) | |
feedback |
any | |
resolved |
boolean | |
update_is_available |
boolean | |
destroy_is_available |
boolean | |
add_comment_is_available |
boolean | |
add_attachment_is_available |
boolean | |
processing_log |
any | Internal processing log for debugging order lifecycle events. Visible only to staff. |
order_uuid |
string | Return order UUID if the issue's resource is an Order. |
order_project_uuid |
string | Return order's project UUID if the issue's resource is an Order. |
order_customer_uuid |
string | Return order's customer UUID if the issue's resource is an Order. |
order_resource_name |
string | Return order's resource name if the issue's resource is an Order. |
Support Priorities
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/support-priorities/ |
List Support Priorities |
| GET | /api/support-priorities/{uuid}/ |
Retrieve |
List Support Priorities
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
support_priorities_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
name |
string | Name |
name_exact |
string | Name (exact) |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
description |
string |
icon_url |
string (uri) |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
support_priorities_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
description |
string |
icon_url |
string (uri) |
Support Request Types Admin
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/support-request-types-admin/ |
List Support Request Types Admin |
| GET | /api/support-request-types-admin/{uuid}/ |
Retrieve |
| POST | /api/support-request-types-admin/ |
Create |
| PUT | /api/support-request-types-admin/{uuid}/ |
Update |
| PATCH | /api/support-request-types-admin/{uuid}/ |
Partial Update |
| DELETE | /api/support-request-types-admin/{uuid}/ |
Delete |
| Other Actions | ||
| POST | /api/support-request-types-admin/{uuid}/activate/ |
Activate a request type so it appears in issue creation |
| POST | /api/support-request-types-admin/{uuid}/deactivate/ |
Deactivate a request type so it no longer appears in issue creation |
| POST | /api/support-request-types-admin/reorder/ |
Bulk update order for multiple request types |
Core CRUD
List Support Request Types Admin
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
support_request_types_admin_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
is_active |
boolean | |
name |
string | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
issue_type_name |
string | |
backend_id |
integer | Backend ID for synced types. Null for manually created types. |
backend_name |
string | |
is_active |
boolean | Whether this request type is available for issue creation. |
order |
integer | Display order. First type (lowest order) is the default. |
is_synced |
boolean | Returns True if the request type was synced from a backend. |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
support_request_types_admin_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
issue_type_name |
string | |
backend_id |
integer | Backend ID for synced types. Null for manually created types. |
backend_name |
string | |
is_active |
boolean | Whether this request type is available for issue creation. |
order |
integer | Display order. First type (lowest order) is the default. |
is_synced |
boolean | Returns True if the request type was synced from a backend. |
Create
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
RequestTypeAdminRequest - API Source:
support_request_types_admin_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ✓ | |
issue_type_name |
string | ✓ | |
is_active |
boolean | Whether this request type is available for issue creation. | |
order |
integer | Display order. First type (lowest order) is the default. |
201 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
issue_type_name |
string | |
backend_id |
integer | Backend ID for synced types. Null for manually created types. |
backend_name |
string | |
is_active |
boolean | Whether this request type is available for issue creation. |
order |
integer | Display order. First type (lowest order) is the default. |
is_synced |
boolean | Returns True if the request type was synced from a backend. |
Update
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
RequestTypeAdminRequest - API Source:
support_request_types_admin_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ✓ | |
issue_type_name |
string | ✓ | |
is_active |
boolean | Whether this request type is available for issue creation. | |
order |
integer | Display order. First type (lowest order) is the default. |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
issue_type_name |
string | |
backend_id |
integer | Backend ID for synced types. Null for manually created types. |
backend_name |
string | |
is_active |
boolean | Whether this request type is available for issue creation. |
order |
integer | Display order. First type (lowest order) is the default. |
is_synced |
boolean | Returns True if the request type was synced from a backend. |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedRequestTypeAdminRequest - API Source:
support_request_types_admin_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ||
issue_type_name |
string | ||
is_active |
boolean | Whether this request type is available for issue creation. | |
order |
integer | Display order. First type (lowest order) is the default. |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
issue_type_name |
string | |
backend_id |
integer | Backend ID for synced types. Null for manually created types. |
backend_name |
string | |
is_active |
boolean | Whether this request type is available for issue creation. |
order |
integer | Display order. First type (lowest order) is the default. |
is_synced |
boolean | Returns True if the request type was synced from a backend. |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
support_request_types_admin_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
Activate a request type so it appears in issue creation
Activate a request type so it appears in issue creation.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
RequestTypeAdminRequest - API Source:
support_request_types_admin_activate
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ✓ | |
issue_type_name |
string | ✓ | |
is_active |
boolean | Whether this request type is available for issue creation. | |
order |
integer | Display order. First type (lowest order) is the default. |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
issue_type_name |
string | |
backend_id |
integer | Backend ID for synced types. Null for manually created types. |
backend_name |
string | |
is_active |
boolean | Whether this request type is available for issue creation. |
order |
integer | Display order. First type (lowest order) is the default. |
is_synced |
boolean | Returns True if the request type was synced from a backend. |
Deactivate a request type so it no longer appears in issue creation
Deactivate a request type so it no longer appears in issue creation.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
RequestTypeAdminRequest - API Source:
support_request_types_admin_deactivate
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ✓ | |
issue_type_name |
string | ✓ | |
is_active |
boolean | Whether this request type is available for issue creation. | |
order |
integer | Display order. First type (lowest order) is the default. |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
issue_type_name |
string | |
backend_id |
integer | Backend ID for synced types. Null for manually created types. |
backend_name |
string | |
is_active |
boolean | Whether this request type is available for issue creation. |
order |
integer | Display order. First type (lowest order) is the default. |
is_synced |
boolean | Returns True if the request type was synced from a backend. |
Bulk update order for multiple request types
Bulk update order for multiple request types.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
RequestTypeAdminRequest - API Source:
support_request_types_admin_reorder
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ✓ | |
issue_type_name |
string | ✓ | |
is_active |
boolean | Whether this request type is available for issue creation. | |
order |
integer | Display order. First type (lowest order) is the default. |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
issue_type_name |
string | |
backend_id |
integer | Backend ID for synced types. Null for manually created types. |
backend_name |
string | |
is_active |
boolean | Whether this request type is available for issue creation. |
order |
integer | Display order. First type (lowest order) is the default. |
is_synced |
boolean | Returns True if the request type was synced from a backend. |
Support Request Types
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/support-request-types/ |
List Support Request Types |
| GET | /api/support-request-types/{uuid}/ |
Retrieve |
List Support Request Types
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
support_request_types_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
issue_type_name |
string | |
order |
integer | Display order. First type (lowest order) is the default. |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
support_request_types_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
url |
string (uri) | |
uuid |
string (uuid) | |
name |
string | |
issue_type_name |
string | |
order |
integer | Display order. First type (lowest order) is the default. |
Support
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/support/settings/atlassian/ |
List Support Settings Atlassian |
| GET | /api/support/settings/atlassian/{id}/ |
Retrieve |
| POST | /api/support/settings/atlassian/ |
Create |
| PUT | /api/support/settings/atlassian/{id}/ |
Update |
| PATCH | /api/support/settings/atlassian/{id}/ |
Partial Update |
| DELETE | /api/support/settings/atlassian/{id}/ |
Delete |
| Other Actions | ||
| GET | /api/support/settings/atlassian/current_settings/ |
Get current Atlassian settings (masked secrets) |
| POST | /api/support/settings/atlassian/discover_custom_fields/ |
Discover available custom fields |
| POST | /api/support/settings/atlassian/discover_priorities/ |
Discover available priorities |
| POST | /api/support/settings/atlassian/discover_projects/ |
Discover available Service Desk projects |
| POST | /api/support/settings/atlassian/discover_request_types/ |
Discover request types for a selected project |
| POST | /api/support/settings/atlassian/preview_settings/ |
Generate preview of settings to be saved |
| POST | /api/support/settings/atlassian/save_settings/ |
Save selected settings to constance |
| POST | /api/support/settings/atlassian/validate_credentials/ |
Validate Atlassian credentials without saving them |
Core CRUD
List Support Settings Atlassian
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
- API Source:
support_settings_atlassian_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 - No response body
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
support_settings_atlassian_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required | Description |
|---|---|---|---|
id |
integer | ✓ | A unique integer value identifying this issue. |
200 - No response body
Create
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
- API Source:
support_settings_atlassian_create
1 2 3 4 5 6 7 8 9 10 | |
201 - No response body
Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
support_settings_atlassian_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required | Description |
|---|---|---|---|
id |
integer | ✓ | A unique integer value identifying this issue. |
200 - No response body
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
support_settings_atlassian_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required | Description |
|---|---|---|---|
id |
integer | ✓ | A unique integer value identifying this issue. |
200 - No response body
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
support_settings_atlassian_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required | Description |
|---|---|---|---|
id |
integer | ✓ | A unique integer value identifying this issue. |
204 - No response body
Other Actions
Get current Atlassian settings (masked secrets)
Get current Atlassian settings (masked secrets).
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
1 2 3 4 5 6 7 8 9 10 | |
200 - No response body
Discover available custom fields
Discover available custom fields.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
DiscoverCustomFieldsRequestRequest - API Source:
support_settings_atlassian_discover_custom_fields
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
| Field | Type | Required | Description |
|---|---|---|---|
api_url |
string (uri) | ✓ | Atlassian API URL (e.g., https://your-domain.atlassian.net) |
auth_method |
any | ✓ | Authentication method to use |
email |
string (email) | ||
token |
string | Constraints: write-only |
|
personal_access_token |
string | Constraints: write-only |
|
username |
string | ||
password |
string | Constraints: write-only |
|
verify_ssl |
boolean | Constraints: default: True |
|
project_id |
string | ||
request_type_id |
string | Optional: Filter fields by request type |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
id |
string |
name |
string |
clause_names |
array of strings |
field_type |
string |
required |
boolean |
Discover available priorities
Discover available priorities.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
DiscoverPrioritiesRequestRequest - API Source:
support_settings_atlassian_discover_priorities
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
| Field | Type | Required | Description |
|---|---|---|---|
api_url |
string (uri) | ✓ | Atlassian API URL (e.g., https://your-domain.atlassian.net) |
auth_method |
any | ✓ | Authentication method to use |
email |
string (email) | ||
token |
string | Constraints: write-only |
|
personal_access_token |
string | Constraints: write-only |
|
username |
string | ||
password |
string | Constraints: write-only |
|
verify_ssl |
boolean | Constraints: default: True |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
id |
string |
name |
string |
description |
string |
icon_url |
string (uri) |
Discover available Service Desk projects
Discover available Service Desk projects.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
DiscoverProjectsRequestRequest - API Source:
support_settings_atlassian_discover_projects
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
| Field | Type | Required | Description |
|---|---|---|---|
api_url |
string (uri) | ✓ | Atlassian API URL (e.g., https://your-domain.atlassian.net) |
auth_method |
any | ✓ | Authentication method to use |
email |
string (email) | ||
token |
string | Constraints: write-only |
|
personal_access_token |
string | Constraints: write-only |
|
username |
string | ||
password |
string | Constraints: write-only |
|
verify_ssl |
boolean | Constraints: default: True |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
id |
string |
key |
string |
name |
string |
description |
string |
Discover request types for a selected project
Discover request types for a selected project.
1 2 3 4 5 6 7 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | |
- Model Source:
DiscoverRequestTypesRequestRequest - API Source:
support_settings_atlassian_discover_request_types
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
| Field | Type | Required | Description |
|---|---|---|---|
api_url |
string (uri) | ✓ | Atlassian API URL (e.g., https://your-domain.atlassian.net) |
auth_method |
any | ✓ | Authentication method to use |
email |
string (email) | ||
token |
string | Constraints: write-only |
|
personal_access_token |
string | Constraints: write-only |
|
username |
string | ||
password |
string | Constraints: write-only |
|
verify_ssl |
boolean | Constraints: default: True |
|
project_id |
string | ✓ | Service Desk project ID or key |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
id |
string |
name |
string |
description |
string |
issue_type_id |
string |
Generate preview of settings to be saved
Generate preview of settings to be saved.
1 2 3 4 5 6 7 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
AtlassianSettingsPreviewRequest - API Source:
support_settings_atlassian_preview_settings
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
| Field | Type | Required | Description |
|---|---|---|---|
api_url |
string (uri) | ✓ | |
auth_method |
string | ✓ | Enum: api_token, personal_access_token, basic |
email |
string (email) | ||
token |
string | Constraints: write-only |
|
personal_access_token |
string | Constraints: write-only |
|
username |
string | ||
password |
string | Constraints: write-only |
|
verify_ssl |
boolean | Constraints: default: True |
|
project_id |
string | ✓ | |
issue_types |
array of strings | ||
support_type_mapping |
object (free-form) | Mapping from frontend types to backend request types | |
reporter_field |
string | ||
impact_field |
string | ||
organisation_field |
string | ||
project_field |
string | ||
affected_resource_field |
string | ||
caller_field |
string | ||
template_field |
string | ||
sla_field |
string | ||
resolution_sla_field |
string | ||
satisfaction_field |
string | ||
request_feedback_field |
string | ||
waldur_backend_id_field |
string | ||
default_offering_issue_type |
string | Default issue type for marketplace request-based orders | |
use_old_api |
boolean | Constraints: default: False |
|
custom_field_mapping_enabled |
boolean | Constraints: default: True |
200 - No response body
Save selected settings to constance
Save selected settings to constance.
1 2 3 4 5 6 7 8 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | |
- Model Source:
AtlassianSettingsSaveRequest - API Source:
support_settings_atlassian_save_settings
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Field | Type | Required | Description |
|---|---|---|---|
api_url |
string (uri) | ✓ | |
auth_method |
string | ✓ | Enum: api_token, personal_access_token, basic |
email |
string (email) | ||
token |
string | Constraints: write-only |
|
personal_access_token |
string | Constraints: write-only |
|
username |
string | ||
password |
string | Constraints: write-only |
|
verify_ssl |
boolean | Constraints: default: True |
|
project_id |
string | ✓ | |
issue_types |
array of strings | ||
support_type_mapping |
object (free-form) | Mapping from frontend types to backend request types | |
reporter_field |
string | ||
impact_field |
string | ||
organisation_field |
string | ||
project_field |
string | ||
affected_resource_field |
string | ||
caller_field |
string | ||
template_field |
string | ||
sla_field |
string | ||
resolution_sla_field |
string | ||
satisfaction_field |
string | ||
request_feedback_field |
string | ||
waldur_backend_id_field |
string | ||
default_offering_issue_type |
string | Default issue type for marketplace request-based orders | |
use_old_api |
boolean | Constraints: default: False |
|
custom_field_mapping_enabled |
boolean | Constraints: default: True |
|
confirm_save |
boolean | ✓ | Must be True to confirm saving settings |
200 - No response body
Validate Atlassian credentials without saving them
Validate Atlassian credentials without saving them.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
AtlassianCredentialsRequest - API Source:
support_settings_atlassian_validate_credentials
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Field | Type | Required | Description |
|---|---|---|---|
api_url |
string (uri) | ✓ | Atlassian API URL (e.g., https://your-domain.atlassian.net) |
auth_method |
any | ✓ | Authentication method to use |
email |
string (email) | ||
token |
string | Constraints: write-only |
|
personal_access_token |
string | Constraints: write-only |
|
username |
string | ||
password |
string | Constraints: write-only |
|
verify_ssl |
boolean | Constraints: default: True |
200 - No response body
Sync Issues
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/sync-issues/ |
This view triggers synchronization of issues from backend |
| Other Actions | ||
| POST | /api/sync-issues/ |
This view triggers synchronization of issues from backend |
Core CRUD
This view triggers synchronization of issues from backend
This view triggers synchronization of issues from backend.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
- API Source:
sync_issues_retrieve
1 2 3 4 5 6 7 8 9 10 | |
202 - No response body
403 - No response body
Other Actions
This view triggers synchronization of issues from backend
This view triggers synchronization of issues from backend.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
- API Source:
sync_issues
1 2 3 4 5 6 7 8 9 10 | |
202 - No response body
403 - No response body
Support Templates
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/support-templates/ |
List Support Templates |
| GET | /api/support-templates/{uuid}/ |
Retrieve |
| POST | /api/support-templates/ |
Create |
| POST | /api/support-templates/{uuid}/create_attachments/ |
This view attaches documents to template |
| PUT | /api/support-templates/{uuid}/ |
Update |
| PATCH | /api/support-templates/{uuid}/ |
Partial Update |
| DELETE | /api/support-templates/{uuid}/ |
Delete |
| Other Actions | ||
| POST | /api/support-templates/{uuid}/delete_attachments/ |
Delete attachments |
Core CRUD
List Support Templates
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
support_templates_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
description |
string |
issue_type |
string |
attachments |
array of objects |
attachments.uuid |
string (uuid) |
attachments.name |
string |
attachments.file |
string (uri) |
attachments.mime_type |
string |
attachments.file_size |
integer |
attachments.created |
string (date-time) |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
support_templates_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
description |
string |
issue_type |
string |
attachments |
array of objects |
attachments.uuid |
string (uuid) |
attachments.name |
string |
attachments.file |
string (uri) |
attachments.mime_type |
string |
attachments.file_size |
integer |
attachments.created |
string (date-time) |
Create
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
TemplateRequest - API Source:
support_templates_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Field | Type | Required |
|---|---|---|
name |
string | ✓ |
description |
string | ✓ |
issue_type |
string |
201 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
description |
string |
issue_type |
string |
attachments |
array of objects |
attachments.uuid |
string (uuid) |
attachments.name |
string |
attachments.file |
string (uri) |
attachments.mime_type |
string |
attachments.file_size |
integer |
attachments.created |
string (date-time) |
This view attaches documents to template
This view attaches documents to template.
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
CreateAttachmentsRequest - API Source:
support_templates_create_attachments
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required | Description |
|---|---|---|---|
attachments |
array of string (binary)s | ✓ | List of files to attach |
201 - No response body
400 - No response body
Update
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
TemplateRequest - API Source:
support_templates_update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
name |
string | ✓ |
description |
string | ✓ |
issue_type |
string |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
description |
string |
issue_type |
string |
attachments |
array of objects |
attachments.uuid |
string (uuid) |
attachments.name |
string |
attachments.file |
string (uri) |
attachments.mime_type |
string |
attachments.file_size |
integer |
attachments.created |
string (date-time) |
Partial Update
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
PatchedTemplateRequest - API Source:
support_templates_partial_update
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
name |
string | |
description |
string | |
issue_type |
string |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
description |
string |
issue_type |
string |
attachments |
array of objects |
attachments.uuid |
string (uuid) |
attachments.name |
string |
attachments.file |
string (uri) |
attachments.mime_type |
string |
attachments.file_size |
integer |
attachments.created |
string (date-time) |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
support_templates_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
Delete attachments
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
DeleteAttachmentsRequest - API Source:
support_templates_delete_attachments
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
attachment_ids |
array of string (uuid)s | ✓ |
200 - No response body
Support Users
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/support-users/ |
List Support Users |
| GET | /api/support-users/{uuid}/ |
Retrieve |
List Support Users
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
support_users_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
backend_id |
string | |
name |
string | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
user |
integer |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
backend_id |
string |
user |
string (uri) |
backend_name |
string |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
support_users_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
url |
string (uri) |
uuid |
string (uuid) |
name |
string |
backend_id |
string |
user |
string (uri) |
backend_name |
string |
Webhooks
Support Jira Webhook
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| POST | /api/support-jira-webhook/ |
Webhook |
Webhook
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
WebHookReceiverRequest - API Source:
support_jira_webhook
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Field | Type | Required | Description |
|---|---|---|---|
webhookEvent |
string | ✓ | |
issue |
object | ✓ | |
issue.key |
string | ✓ | Jira issue key |
issue.fields |
object | ✓ | |
issue.fields.project |
object | ✓ | |
issue.fields.project.id |
string | ✓ | Jira field ID |
issue.fields.project.name |
string | ✓ | Jira field name |
issue.fields.project.key |
string | ✓ | Jira project key |
issue.fields.comment |
object (free-form) | ||
comment |
object | ||
comment.id |
string | ✓ | Jira comment ID |
changelog |
object | ||
changelog.items |
array of anys | ✓ | List of changelog items |
issue_event_type_name |
string |
200 -
| Field | Type | Description |
|---|---|---|
webhookEvent |
string | |
issue |
object | |
issue.key |
string | Jira issue key |
issue.fields |
object | |
issue.fields.project |
object | |
issue.fields.project.id |
string | Jira field ID |
issue.fields.project.name |
string | Jira field name |
issue.fields.project.key |
string | Jira project key |
issue.fields.comment |
object (free-form) | |
comment |
object | |
comment.id |
string | Jira comment ID |
changelog |
object | |
changelog.items |
array of anys | List of changelog items |
issue_event_type_name |
string |
Support Smax Webhook
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| POST | /api/support-smax-webhook/ |
Webhook |
Webhook
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
- Model Source:
SmaxWebHookReceiverRequest - API Source:
support_smax_webhook
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Field | Type | Required |
|---|---|---|
id |
string | ✓ |
200 -
| Field | Type |
|---|---|
id |
string |
Support Zammad Webhook
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| POST | /api/support-zammad-webhook/ |
Webhook |
Webhook
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
- API Source:
support_zammad_webhook
1 2 3 4 5 6 7 8 9 10 | |
200 - No response body
Uncategorized
Identity bridge
Identity Bridge
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/identity-bridge/stats/ |
Get Identity Bridge statistics |
| POST | /api/identity-bridge/ |
Push user attributes from an ISD |
| POST | /api/identity-bridge/remove/ |
Remove a user from an ISD |
Get Identity Bridge statistics
Returns system-wide statistics about the Identity Bridge: feature configuration, per-ISD user counts, stale attribute detection, and total federated user counts. Staff only.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
- API Source:
identity_bridge_stats_retrieve
1 2 3 4 5 6 7 8 9 10 | |
200 -
| Field | Type |
|---|---|
enabled |
boolean |
deactivation_policy |
string |
allowed_attributes |
array of strings |
total_federated_users |
integer |
total_active_federated_users |
integer |
users_per_isd |
array of objects |
users_per_isd.isd |
string |
users_per_isd.user_count |
integer |
users_per_isd.stale_user_count |
integer |
users_per_isd.oldest_sync |
string |
stale_threshold_days |
integer |
identity_managers |
array of objects |
identity_managers.uuid |
string (uuid) |
identity_managers.full_name |
string |
identity_managers.managed_isds |
array of strings |
Push user attributes from an ISD
Allows Identity Service Domains (ISDs) to push user attributes to Waldur. Creates or updates a user based on username (CUID). Requires FEDERATED_IDENTITY_SYNC_ENABLED to be True. Caller must be staff or an identity manager with the declared source in managed_isds.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
IdentityBridgeRequestRequest - API Source:
identity_bridge
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Field | Type | Required | Description |
|---|---|---|---|
username |
string | ✓ | CUID / username of the user to create or update. |
source |
string | ✓ | ISD source identifier, e.g. 'isd:puhuri'. Must match ^[a-z]+:[a-zA-Z0-9._-]+$. |
first_name |
string | ||
last_name |
string | ||
email |
string (email) | ||
organization |
string | ||
affiliations |
array of strings | ||
civil_number |
string | ||
phone_number |
string | ||
identity_source |
string | ||
gender |
integer | ||
personal_title |
string | ||
birth_date |
string (date) | ||
place_of_birth |
string | ||
country_of_residence |
string | ||
nationality |
string | ||
nationalities |
array of strings | ||
organization_country |
string | ||
organization_type |
string | ||
eduperson_assurance |
array of strings |
200 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
created |
boolean |
updated_fields |
array of strings |
Remove a user from an ISD
Signals that a user has been removed from an ISD. Removes the source from active_isds, clears attributes owned by that source, and deactivates the user if no ISDs remain (configurable via FEDERATED_IDENTITY_DEACTIVATION_POLICY). Requires FEDERATED_IDENTITY_SYNC_ENABLED to be True. Caller must be staff or an identity manager with the declared source in managed_isds.
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | |
- Model Source:
IdentityBridgeRemoveRequest - API Source:
identity_bridge_remove
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Field | Type | Required | Description |
|---|---|---|---|
username |
string | ✓ | CUID / username of the user to remove from the ISD. |
source |
string | ✓ | ISD source identifier, e.g. 'isd:puhuri'. Must match ^[a-z]+:[a-zA-Z0-9._-]+$. |
200 -
| Field | Type |
|---|---|
uuid |
string (uuid) |
deactivated |
boolean |
Offering keycloak groups
Offering Keycloak Groups
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/offering-keycloak-groups/ |
List Offering Keycloak Groups |
| GET | /api/offering-keycloak-groups/{uuid}/ |
Retrieve |
| POST | /api/offering-keycloak-groups/{uuid}/pull_members/ |
Pull members from Keycloak for a group |
| DELETE | /api/offering-keycloak-groups/{uuid}/ |
Delete |
| Other Actions | ||
| GET | /api/offering-keycloak-groups/remote_group_members/ |
List members of a remote Keycloak group |
| GET | /api/offering-keycloak-groups/remote_groups/ |
List remote Keycloak groups for an offering |
| GET | /api/offering-keycloak-groups/search_remote_users/ |
Search for users in remote Keycloak instance |
| GET | /api/offering-keycloak-groups/sync_status/ |
Compare local and remote Keycloak group state |
| POST | /api/offering-keycloak-groups/import_remote/ |
Import a remote Keycloak group as a local OfferingKeycloakGroup |
| POST | /api/offering-keycloak-groups/{uuid}/set_backend_id/ |
Set or unlink the backend_id (remote Keycloak group ID) for a local group |
| POST | /api/offering-keycloak-groups/test_connection/ |
Test Keycloak connection for an offering |
Core CRUD
List Offering Keycloak Groups
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 | |
- API Source:
offering_keycloak_groups_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
offering_uuid |
string (uuid) | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
resource_uuid |
string (uuid) | |
role_uuid |
string (uuid) |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
name |
string | |
backend_id |
string | |
offering |
string (uri) | |
offering_uuid |
string (uuid) | |
offering_name |
string | |
role |
string (uri) | |
role_name |
string | |
role_scope_type |
string | Level this role applies at, e.g. 'cluster', 'project'. Empty means offering-wide. |
resource |
string (uri) | |
resource_uuid |
string (uuid) | |
resource_name |
string | |
scope_id |
string | Sub-entity identifier within a resource, e.g. Rancher project ID within a cluster. |
created |
string (date-time) | |
modified |
string (date-time) |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
offering_keycloak_groups_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
name |
string | |
backend_id |
string | |
offering |
string (uri) | |
offering_uuid |
string (uuid) | |
offering_name |
string | |
role |
string (uri) | |
role_name |
string | |
role_scope_type |
string | Level this role applies at, e.g. 'cluster', 'project'. Empty means offering-wide. |
resource |
string (uri) | |
resource_uuid |
string (uuid) | |
resource_name |
string | |
scope_id |
string | Sub-entity identifier within a resource, e.g. Rancher project ID within a cluster. |
created |
string (date-time) | |
modified |
string (date-time) |
Pull members from Keycloak for a group
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
offering_keycloak_groups_pull_members
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
created |
integer |
updated |
integer |
total_remote |
integer |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
offering_keycloak_groups_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
Other Actions
List members of a remote Keycloak group
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Name | Type | Required | Description |
|---|---|---|---|
group_id |
string | ✓ | Keycloak group ID |
offering_uuid |
string | ✓ | UUID of the offering |
page |
integer | A page number within the paginated result set. | |
page_size |
integer | Number of results to return per page. | |
resource_uuid |
string (uuid) | ||
role_uuid |
string (uuid) |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
id |
string |
username |
string |
email |
string |
first_name |
string |
last_name |
string |
List remote Keycloak groups for an offering
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- API Source:
offering_keycloak_groups_remote_groups_list
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required | Description |
|---|---|---|---|
offering_uuid |
string | ✓ | UUID of the offering |
page |
integer | A page number within the paginated result set. | |
page_size |
integer | Number of results to return per page. | |
resource_uuid |
string (uuid) | ||
role_uuid |
string (uuid) |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
id |
string |
name |
string |
path |
string |
sub_group_count |
integer |
Search for users in remote Keycloak instance
1 2 3 4 5 6 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | |
| Name | Type | Required | Description |
|---|---|---|---|
offering_uuid |
string | ✓ | UUID of the offering |
page |
integer | A page number within the paginated result set. | |
page_size |
integer | Number of results to return per page. | |
q |
string | ✓ | Search query for username, email, or name |
resource_uuid |
string (uuid) | ||
role_uuid |
string (uuid) |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
id |
string |
username |
string |
email |
string |
first_name |
string |
last_name |
string |
Compare local and remote Keycloak group state
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
offering_keycloak_groups_sync_status_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required | Description |
|---|---|---|---|
offering_uuid |
string | ✓ | UUID of the offering |
200 -
| Field | Type |
|---|---|
local_only |
array of strings |
remote_only |
array of strings |
synced |
array of objects |
synced.local_name |
string |
synced.remote_name |
string |
synced.backend_id |
string |
Import a remote Keycloak group as a local OfferingKeycloakGroup
1 2 3 4 5 6 7 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | |
- Model Source:
ImportRemoteGroupRequest - API Source:
offering_keycloak_groups_import_remote
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | |
| Field | Type | Required |
|---|---|---|
offering_uuid |
string (uuid) | ✓ |
role_uuid |
string (uuid) | ✓ |
remote_group_id |
string | ✓ |
resource_uuid |
string (uuid) | |
scope_id |
string |
201 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
name |
string | |
backend_id |
string | |
offering |
string (uri) | |
offering_uuid |
string (uuid) | |
offering_name |
string | |
role |
string (uri) | |
role_name |
string | |
role_scope_type |
string | Level this role applies at, e.g. 'cluster', 'project'. Empty means offering-wide. |
resource |
string (uri) | |
resource_uuid |
string (uuid) | |
resource_name |
string | |
scope_id |
string | Sub-entity identifier within a resource, e.g. Rancher project ID within a cluster. |
created |
string (date-time) | |
modified |
string (date-time) |
Set or unlink the backend_id (remote Keycloak group ID) for a local group
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
- Model Source:
SetBackendIdRequest - API Source:
offering_keycloak_groups_set_backend_id
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
| Field | Type | Required |
|---|---|---|
backend_id |
string | |
resource_uuid |
string (uuid) | |
scope_id |
string |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
name |
string | |
backend_id |
string | |
offering |
string (uri) | |
offering_uuid |
string (uuid) | |
offering_name |
string | |
role |
string (uri) | |
role_name |
string | |
role_scope_type |
string | Level this role applies at, e.g. 'cluster', 'project'. Empty means offering-wide. |
resource |
string (uri) | |
resource_uuid |
string (uuid) | |
resource_name |
string | |
scope_id |
string | Sub-entity identifier within a resource, e.g. Rancher project ID within a cluster. |
created |
string (date-time) | |
modified |
string (date-time) |
Test Keycloak connection for an offering
1 2 3 4 5 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | |
- Model Source:
OfferingUUIDRequest - API Source:
offering_keycloak_groups_test_connection
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Field | Type | Required |
|---|---|---|
offering_uuid |
string (uuid) | ✓ |
200 -
| Field | Type |
|---|---|
status |
string |
groups_count |
integer |
groups |
array of strings |
Offering keycloak memberships
Offering Keycloak Memberships
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/offering-keycloak-memberships/ |
List Offering Keycloak Memberships |
| GET | /api/offering-keycloak-memberships/{uuid}/ |
Retrieve |
| POST | /api/offering-keycloak-memberships/ |
Create |
| DELETE | /api/offering-keycloak-memberships/{uuid}/ |
Delete |
List Offering Keycloak Memberships
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 | |
- Model Source:
KeycloakUserGroupMembershipState - API Source:
offering_keycloak_memberships_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
email |
string | |
first_name |
string | |
group_uuid |
string (uuid) | |
last_name |
string | |
offering_uuid |
string (uuid) | |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
resource_uuid |
string (uuid) | |
role_uuid |
string (uuid) | |
state |
array | |
username |
string |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
username |
string | Keycloak user username |
email |
string (email) | User's email for notifications |
first_name |
string | |
last_name |
string | |
group |
string (uri) | |
group_name |
string | |
group_role_name |
string | |
group_offering_uuid |
string (uuid) | |
group_offering_name |
string | |
group_resource_name |
string | |
group_resource_uuid |
string (uuid) | |
group_scope_id |
string | Sub-entity identifier within a resource, e.g. Rancher project ID within a cluster. |
group_role_scope_type |
string | Level this role applies at, e.g. 'cluster', 'project'. Empty means offering-wide. |
group_role_scope_type_label |
string | Human-readable label for scope_type shown to end users, e.g. 'Rancher Project', 'Cluster Namespace'. Falls back to capitalized scope_type if empty. |
user |
string (uri) | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
last_checked |
string (date-time) | |
error_message |
string | |
error_traceback |
string |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
offering_keycloak_memberships_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
200 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
username |
string | Keycloak user username |
email |
string (email) | User's email for notifications |
first_name |
string | |
last_name |
string | |
group |
string (uri) | |
group_name |
string | |
group_role_name |
string | |
group_offering_uuid |
string (uuid) | |
group_offering_name |
string | |
group_resource_name |
string | |
group_resource_uuid |
string (uuid) | |
group_scope_id |
string | Sub-entity identifier within a resource, e.g. Rancher project ID within a cluster. |
group_role_scope_type |
string | Level this role applies at, e.g. 'cluster', 'project'. Empty means offering-wide. |
group_role_scope_type_label |
string | Human-readable label for scope_type shown to end users, e.g. 'Rancher Project', 'Cluster Namespace'. Falls back to capitalized scope_type if empty. |
user |
string (uri) | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
last_checked |
string (date-time) | |
error_message |
string | |
error_traceback |
string |
Create
1 2 3 4 5 6 7 8 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | |
- Model Source:
OfferingKeycloakMembershipRequest - API Source:
offering_keycloak_memberships_create
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | |
| Field | Type | Required | Description |
|---|---|---|---|
username |
string | ✓ | Keycloak user username |
email |
string (email) | ✓ | User's email for notifications |
offering |
string (uri) | ✓ | Constraints: write-only |
role |
string (uri) | ✓ | Constraints: write-only |
resource |
string (uri) | Constraints: write-only |
|
scope_id |
string | Constraints: write-only, default: `` |
|
user |
string (uri) |
201 -
| Field | Type | Description |
|---|---|---|
uuid |
string (uuid) | |
url |
string (uri) | |
username |
string | Keycloak user username |
email |
string (email) | User's email for notifications |
first_name |
string | |
last_name |
string | |
group |
string (uri) | |
group_name |
string | |
group_role_name |
string | |
group_offering_uuid |
string (uuid) | |
group_offering_name |
string | |
group_resource_name |
string | |
group_resource_uuid |
string (uuid) | |
group_scope_id |
string | Sub-entity identifier within a resource, e.g. Rancher project ID within a cluster. |
group_role_scope_type |
string | Level this role applies at, e.g. 'cluster', 'project'. Empty means offering-wide. |
group_role_scope_type_label |
string | Human-readable label for scope_type shown to end users, e.g. 'Rancher Project', 'Cluster Namespace'. Falls back to capitalized scope_type if empty. |
user |
string (uri) | |
state |
any | |
created |
string (date-time) | |
modified |
string (date-time) | |
last_checked |
string (date-time) | |
error_message |
string | |
error_traceback |
string |
Delete
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
offering_keycloak_memberships_destroy
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required |
|---|---|---|
uuid |
string (uuid) | ✓ |
204 - No response body
System logs
System Logs
Operations Summary
| Method | Endpoint | Description |
|---|---|---|
| Core CRUD | ||
| GET | /api/system-logs/ |
List System Logs |
| GET | /api/system-logs/{id}/ |
Retrieve |
| Other Actions | ||
| GET | /api/system-logs/instances/ |
List system log instances |
| GET | /api/system-logs/stats/ |
Get system log statistics |
Core CRUD
List System Logs
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
SystemLogLevelEnum - Model Source:
SystemLogOEnum - Model Source:
SystemLogSourceEnum - API Source:
system_logs_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
created_from |
number | |
created_to |
number | |
instance |
string | |
level |
string | Enum: CRITICAL, ERROR, INFO, WARNING |
level_gte |
integer | Min level: 20=INFO, 30=WARNING, 40=ERROR, 50=CRITICAL |
logger_name |
string | |
message |
string | |
o |
array | Ordering |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
source |
string | Enum: api, worker, beat |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type | Description |
|---|---|---|
id |
integer | |
created |
string (date-time) | |
source |
any | |
instance |
string | Pod name (K8s) or container name (Docker) |
level |
string | |
level_number |
integer | |
logger_name |
string | |
message |
string | |
context |
any |
Retrieve
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 | |
- API Source:
system_logs_retrieve
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
| Name | Type | Required | Description |
|---|---|---|---|
id |
integer | ✓ | A unique integer value identifying this system log. |
200 -
| Field | Type | Description |
|---|---|---|
id |
integer | |
created |
string (date-time) | |
source |
any | |
instance |
string | Pod name (K8s) or container name (Docker) |
level |
string | |
level_number |
integer | |
logger_name |
string | |
message |
string | |
context |
any |
Other Actions
List system log instances
List all known instances (pods/containers) with their last activity.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 10 11 12 13 | |
- Model Source:
SystemLogLevelEnum - Model Source:
SystemLogOEnum - Model Source:
SystemLogSourceEnum - API Source:
system_logs_instances_list
1 2 3 4 5 6 7 8 9 10 | |
| Name | Type | Description |
|---|---|---|
created_from |
number | |
created_to |
number | |
instance |
string | |
level |
string | Enum: CRITICAL, ERROR, INFO, WARNING |
level_gte |
integer | Min level: 20=INFO, 30=WARNING, 40=ERROR, 50=CRITICAL |
logger_name |
string | |
message |
string | |
o |
array | Ordering |
page |
integer | A page number within the paginated result set. |
page_size |
integer | Number of results to return per page. |
source |
string | Enum: api, worker, beat |
200 -
The response body is an array of objects, where each object has the following structure:
| Field | Type |
|---|---|
source |
string |
instance |
string |
last_seen |
string (date-time) |
count |
integer |
Get system log statistics
Return log count statistics per source and instance, plus total table size.
1 2 3 4 | |
1 2 3 4 5 6 7 8 9 | |
- API Source:
system_logs_stats_retrieve
1 2 3 4 5 6 7 8 9 10 | |
200 -
| Field | Type |
|---|---|
instances |
array of objects |
instances.source |
string |
instances.instance |
string |
instances.count |
integer |
total_size_bytes |
integer |
total_size_mb |
number (double) |